Serialized Form (AWS SDK for Java

Package com.amazonaws
- Class com.amazonaws.AbortedException extends AmazonClientException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.AmazonClientException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.AmazonServiceException extends AmazonClientException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
      The unique AWS identifier for the service request the caller made. The AWS request ID can uniquely identify the AWS request, and is used for reporting an error to AWS support team.
    - errorCode
```
String errorCode
```
      The AWS error code represented by this exception (ex: InvalidParameterValue).
    - errorType
```
AmazonServiceException.ErrorType errorType
```
      Indicates (if known) whether this exception was the fault of the caller or the service.
      
      See Also:
      AmazonServiceException.ErrorType
    - errorMessage
```
String errorMessage
```
      The error message as returned by the service.
    - statusCode
```
int statusCode
```
      The HTTP status code that was returned with this error
    - serviceName
```
String serviceName
```
      The name of the Amazon service that sent this error response.
    - rawResponse
```
byte[] rawResponse
```
      The raw response payload.
- Class com.amazonaws.ResetException extends AmazonClientException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - extraInfo
```
String extraInfo
```
Package com.amazonaws.http.exception
- Class com.amazonaws.http.exception.HttpRequestTimeoutException extends IOException implements Serializable
  
  serialVersionUID:
  
  -2588353895012259837L
Package com.amazonaws.http.timers.client
- Class com.amazonaws.http.timers.client.ClientExecutionTimeoutException extends AmazonClientException implements Serializable
  
  serialVersionUID:
  
  4861767589924758934L
- Class com.amazonaws.http.timers.client.SdkInterruptedException extends InterruptedException implements Serializable
  
  serialVersionUID:
  
  8194951388566545094L
Package com.amazonaws.services.apigateway.model
- Class com.amazonaws.services.apigateway.model.ApiKey extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - createdDate
```
Date createdDate
```
      The date when the API Key was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      When the API Key was last updated, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.Authorizer extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      [Required] The type of the authorizer. Currently, the only valid type is TOKEN.
    - authType
```
String authType
```
      Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    - authorizerUri
```
String authorizerUri
```
      [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI. The URI should be of the form arn:aws:apigateway:{region}:lambda:path/{service_api}. Region is used to determine the right endpoint. In this case, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      [Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.BadRequestException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.BasePathMapping extends Object implements Serializable
  - Serialized Fields
    - basePath
```
String basePath
```
      The base path name that callers of the API must provide as part of the URL after the domain name.
    - restApiId
```
String restApiId
```
      The name of the API.
    - stage
```
String stage
```
      The name of the API's stage.
- Class com.amazonaws.services.apigateway.model.ClientCertificate extends Object implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the Client Certificate.
    - description
```
String description
```
      The description of the Client Certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The date when the Client Certificate was created, in ISO 8601 format.
    - expirationDate
```
Date expirationDate
```
      The date when the Client Certificate will expire, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.ConflictException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.CreateApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the ApiKey.
    - description
```
String description
```
      The description of the ApiKey.
    - enabled
```
Boolean enabled
```
      Specifies whether the ApiKey can be used by callers.
    - stageKeys
```
List<E> stageKeys
```
      Specifies whether the ApiKey can be used by callers.
- Class com.amazonaws.services.apigateway.model.CreateApiKeyResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - createdDate
```
Date createdDate
```
      The date when the API Key was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      When the API Key was last updated, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.CreateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier under which the Authorizer will be created.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      [Required] The type of the authorizer.
    - authType
```
String authType
```
      Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    - authorizerUri
```
String authorizerUri
```
      [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the credentials required for the authorizer, if any.
    - identitySource
```
String identitySource
```
      [Required] The source of the identity in an incoming request.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL of cached authorizer results.
- Class com.amazonaws.services.apigateway.model.CreateAuthorizerResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      [Required] The type of the authorizer. Currently, the only valid type is TOKEN.
    - authType
```
String authType
```
      Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    - authorizerUri
```
String authorizerUri
```
      [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI. The URI should be of the form arn:aws:apigateway:{region}:lambda:path/{service_api}. Region is used to determine the right endpoint. In this case, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      [Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.CreateBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name of the BasePathMapping resource to create.
    - basePath
```
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.
    - restApiId
```
String restApiId
```
      The name of the API that you want to apply this mapping to.
    - stage
```
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.
- Class com.amazonaws.services.apigateway.model.CreateBasePathMappingResult extends Object implements Serializable
  - Serialized Fields
    - basePath
```
String basePath
```
      The base path name that callers of the API must provide as part of the URL after the domain name.
    - restApiId
```
String restApiId
```
      The name of the API.
    - stage
```
String stage
```
      The name of the API's stage.
- Class com.amazonaws.services.apigateway.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi resource identifier for the Deployment resource to create.
    - stageName
```
String stageName
```
      The name of the Stage resource for the Deployment resource to create.
    - stageDescription
```
String stageDescription
```
      The description of the Stage resource for the Deployment resource to create.
    - description
```
String description
```
      The description for the Deployment resource to create.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Enables a cache cluster for the Stage resource specified in the input.
    - cacheClusterSize
```
String cacheClusterSize
```
      Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
    - variables
```
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 alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
- Class com.amazonaws.services.apigateway.model.CreateDeploymentResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      Gets a summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.CreateDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - certificateName
```
String certificateName
```
      The name of the certificate.
    - certificateBody
```
String certificateBody
```
      The body of the server certificate provided by your certificate authority.
    - certificatePrivateKey
```
String certificatePrivateKey
```
      Your certificate's private key.
    - certificateChain
```
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.
- Class com.amazonaws.services.apigateway.model.CreateDomainNameResult extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - certificateName
```
String certificateName
```
      The name of the certificate.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The date when the certificate was uploaded, in ISO 8601 format.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
- Class com.amazonaws.services.apigateway.model.CreateModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier under which the Model will be created.
    - name
```
String name
```
      The name of the model.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.CreateModelResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.CreateResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi for the resource.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
- Class com.amazonaws.services.apigateway.model.CreateResourceResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Map of methods for this resource, which is included only if the request uses the embed query option.
- Class com.amazonaws.services.apigateway.model.CreateRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the RestApi.
    - description
```
String description
```
      The description of the RestApi.
    - cloneFrom
```
String cloneFrom
```
      The Id of the RestApi that you want to clone from.
- Class com.amazonaws.services.apigateway.model.CreateRestApiResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The date when the API was created, in ISO 8601 format.
    - warnings
```
List<E> warnings
```
- Class com.amazonaws.services.apigateway.model.CreateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource for the Stage resource to create.
    - stageName
```
String stageName
```
      The name for the Stage resource.
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment resource for the Stage resource.
    - description
```
String description
```
      The description of the Stage resource.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Whether cache clustering is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The stage's cache cluster size.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
- Class com.amazonaws.services.apigateway.model.CreateStageResult extends Object implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
    - stageName
```
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.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
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.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - createdDate
```
Date createdDate
```
      The date and time that the stage was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The date and time that information about the stage was last updated, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.DeleteApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      The identifier of the ApiKey resource to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Authorizer resource.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource.
- Class com.amazonaws.services.apigateway.model.DeleteBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name of the BasePathMapping resource to delete.
    - basePath
```
String basePath
```
      The base path name of the BasePathMapping resource to delete.
- Class com.amazonaws.services.apigateway.model.DeleteClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the ClientCertificate resource to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource for the Deployment resource to delete.
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment resource to delete.
- Class com.amazonaws.services.apigateway.model.DeleteDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource to be deleted.
- Class com.amazonaws.services.apigateway.model.DeleteIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a delete integration request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies a delete integration request's resource identifier.
    - httpMethod
```
String httpMethod
```
      Specifies a delete integration request's HTTP method.
- Class com.amazonaws.services.apigateway.model.DeleteIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a delete integration response request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies a delete integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      Specifies a delete integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      Specifies a delete integration response request's status code.
- Class com.amazonaws.services.apigateway.model.DeleteMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Method resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      The HTTP verb that identifies the Method resource.
- Class com.amazonaws.services.apigateway.model.DeleteMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the MethodResponse resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the MethodResponse resource.
    - httpMethod
```
String httpMethod
```
      The HTTP verb identifier for the parent Method resource.
    - statusCode
```
String statusCode
```
      The status code identifier for the MethodResponse resource.
- Class com.amazonaws.services.apigateway.model.DeleteModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi under which the model will be deleted.
    - modelName
```
String modelName
```
      The name of the model to delete.
- Class com.amazonaws.services.apigateway.model.DeleteResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Resource resource.
    - resourceId
```
String resourceId
```
      The identifier of the Resource resource.
- Class com.amazonaws.services.apigateway.model.DeleteRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The ID of the RestApi you want to delete.
- Class com.amazonaws.services.apigateway.model.DeleteStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource for the Stage resource to delete.
    - stageName
```
String stageName
```
      The name of the Stage resource to delete.
- Class com.amazonaws.services.apigateway.model.Deployment extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      Gets a summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.DomainName extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - certificateName
```
String certificateName
```
      The name of the certificate.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The date when the certificate was uploaded, in ISO 8601 format.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
- Class com.amazonaws.services.apigateway.model.FlushStageAuthorizersCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The API identifier of the stage to flush.
    - stageName
```
String stageName
```
      The name of the stage to flush.
- Class com.amazonaws.services.apigateway.model.FlushStageCacheRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The API identifier of the stage to flush its cache.
    - stageName
```
String stageName
```
      The name of the stage to flush its cache.
- Class com.amazonaws.services.apigateway.model.GenerateClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - description
```
String description
```
      The description of the ClientCertificate.
- Class com.amazonaws.services.apigateway.model.GenerateClientCertificateResult extends Object implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the Client Certificate.
    - description
```
String description
```
      The description of the Client Certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The date when the Client Certificate was created, in ISO 8601 format.
    - expirationDate
```
Date expirationDate
```
      The date when the Client Certificate will expire, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.GetAccountRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.apigateway.model.GetAccountResult extends Object implements Serializable
  - Serialized Fields
    - cloudwatchRoleArn
```
String cloudwatchRoleArn
```
      Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
    - throttleSettings
```
ThrottleSettings throttleSettings
```
      Specifies the application programming interface (API) throttle settings for the current Account resource.
- Class com.amazonaws.services.apigateway.model.GetApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      The identifier of the ApiKey resource.
- Class com.amazonaws.services.apigateway.model.GetApiKeyResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - createdDate
```
Date createdDate
```
      The date when the API Key was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      When the API Key was last updated, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.GetApiKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The position of the current ApiKeys resource to get information about.
    - limit
```
Integer limit
```
      The maximum number of ApiKeys to get information about.
- Class com.amazonaws.services.apigateway.model.GetApiKeysResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of any ApiKey resources in the collection of ApiKey resources.
- Class com.amazonaws.services.apigateway.model.GetAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Authorizer resource.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource.
- Class com.amazonaws.services.apigateway.model.GetAuthorizerResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      [Required] The type of the authorizer. Currently, the only valid type is TOKEN.
    - authType
```
String authType
```
      Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    - authorizerUri
```
String authorizerUri
```
      [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI. The URI should be of the form arn:aws:apigateway:{region}:lambda:path/{service_api}. Region is used to determine the right endpoint. In this case, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      [Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.GetAuthorizersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Authorizers resource.
    - position
```
String position
```
      If not all Authorizer resources in the response were present, the position will specificy where to start the next page of results.
    - limit
```
Integer limit
```
      Limit the number of Authorizer resources in the response.
- Class com.amazonaws.services.apigateway.model.GetAuthorizersResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      Gets the current list of Authorizer resources in the collection.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name of the BasePathMapping resource to be described.
    - basePath
```
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.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingResult extends Object implements Serializable
  - Serialized Fields
    - basePath
```
String basePath
```
      The base path name that callers of the API must provide as part of the URL after the domain name.
    - restApiId
```
String restApiId
```
      The name of the API.
    - stage
```
String stage
```
      The name of the API's stage.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name of a BasePathMapping resource.
    - position
```
String position
```
      The position of the current BasePathMapping resource in the collection to get information about.
    - limit
```
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.
- Class com.amazonaws.services.apigateway.model.GetBasePathMappingsResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of any BasePathMapping resources in the collection of base path mapping resources.
- Class com.amazonaws.services.apigateway.model.GetClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the ClientCertificate resource to be described.
- Class com.amazonaws.services.apigateway.model.GetClientCertificateResult extends Object implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the Client Certificate.
    - description
```
String description
```
      The description of the Client Certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The date when the Client Certificate was created, in ISO 8601 format.
    - expirationDate
```
Date expirationDate
```
      The date when the Client Certificate will expire, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.GetClientCertificatesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The position of the current ClientCertificate resource in the collection to get information about.
    - limit
```
Integer limit
```
      The maximum number of ClientCertificate resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
- Class com.amazonaws.services.apigateway.model.GetClientCertificatesResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of any ClientCertificate resources in the collection of ClientCertificate resources.
- Class com.amazonaws.services.apigateway.model.GetDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource for the Deployment resource to get information about.
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment resource to get information about.
- Class com.amazonaws.services.apigateway.model.GetDeploymentResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      Gets a summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.GetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource for the collection of Deployment resources to get information about.
    - position
```
String position
```
      The position of the current Deployment resource in the collection to get information about.
    - limit
```
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.
- Class com.amazonaws.services.apigateway.model.GetDeploymentsResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of any Deployment resources in the collection of deployment resources.
- Class com.amazonaws.services.apigateway.model.GetDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource.
- Class com.amazonaws.services.apigateway.model.GetDomainNameResult extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - certificateName
```
String certificateName
```
      The name of the certificate.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The date when the certificate was uploaded, in ISO 8601 format.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
- Class com.amazonaws.services.apigateway.model.GetDomainNamesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The position of the current domain names to get information about.
    - limit
```
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.
- Class com.amazonaws.services.apigateway.model.GetDomainNamesResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      The current page of any DomainName resources in the collection of DomainName resources.
- Class com.amazonaws.services.apigateway.model.GetExportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi to be exported.
    - stageName
```
String stageName
```
      The name of the Stage that will be exported.
    - exportType
```
String exportType
```
      The type of export. Currently only 'swagger' is supported.
    - parameters
```
Map<K,V> parameters
```
      A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType 'swagger', any combination of the following parameters are supported: 'integrations' will export x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool
    - accepts
```
String accepts
```
      The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.
- Class com.amazonaws.services.apigateway.model.GetExportResult extends Object implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
    - contentDisposition
```
String contentDisposition
```
      The content-disposition header value in the HTTP reseponse.
    - body
```
ByteBuffer body
```
      The binary blob response to GetExport, which contains the export.
- Class com.amazonaws.services.apigateway.model.GetIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a get integration request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies a get integration request's resource identifier
    - httpMethod
```
String httpMethod
```
      Specifies a get integration request's HTTP method.
- Class com.amazonaws.services.apigateway.model.GetIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a get integration response request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies a get integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      Specifies a get integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      Specifies a get integration response request's status code.
- Class com.amazonaws.services.apigateway.model.GetIntegrationResponseResult extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
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.
    - responseParameters
```
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 MethodResponse. 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}.
    - responseTemplates
```
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.
- Class com.amazonaws.services.apigateway.model.GetIntegrationResult extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
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}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain 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 /.
    - credentials
```
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.
    - requestParameters
```
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.
    - requestTemplates
```
Map<K,V> requestTemplates
```
      Specifies the integration's request templates.
    - cacheNamespace
```
String cacheNamespace
```
      Specifies the integration's cache namespace.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      Specifies the integration's cache key parameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
- Class com.amazonaws.services.apigateway.model.GetMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Method resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      Specifies the put method request's HTTP method type.
- Class com.amazonaws.services.apigateway.model.GetMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the MethodResponse resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the MethodResponse resource.
    - httpMethod
```
String httpMethod
```
      The HTTP verb identifier for the parent Method resource.
    - statusCode
```
String statusCode
```
      The status code identifier for the MethodResponse resource.
- Class com.amazonaws.services.apigateway.model.GetMethodResponseResult extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
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.
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.GetMethodResult extends Object implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The HTTP method.
    - authorizationType
```
String authorizationType
```
      The method's authorization type.
    - authorizerId
```
String authorizerId
```
      Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method requires a valid ApiKey.
    - requestParameters
```
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.
    - requestModels
```
Map<K,V> requestModels
```
      Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
    - methodResponses
```
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.
    - methodIntegration
```
Integration methodIntegration
```
      The method's integration.
- Class com.amazonaws.services.apigateway.model.GetModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier under which the Model exists.
    - modelName
```
String modelName
```
      The name of the model as an identifier.
    - flatten
```
Boolean flatten
```
      Resolves all external model references and returns a flattened model schema.
- Class com.amazonaws.services.apigateway.model.GetModelResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.GetModelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier.
    - position
```
String position
```
      The position of the next set of results in the Models resource to get information about.
    - limit
```
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.
- Class com.amazonaws.services.apigateway.model.GetModelsResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      Gets the current Model resource in the collection.
- Class com.amazonaws.services.apigateway.model.GetModelTemplateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The ID of the RestApi under which the model exists.
    - modelName
```
String modelName
```
      The name of the model for which to generate a template.
- Class com.amazonaws.services.apigateway.model.GetModelTemplateResult extends Object implements Serializable
  - Serialized Fields
    - value
```
String value
```
      The Apache Velocity Template Language (VTL) template content used for the template resource.
- Class com.amazonaws.services.apigateway.model.GetResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the resource.
    - resourceId
```
String resourceId
```
      The identifier for the Resource resource.
- Class com.amazonaws.services.apigateway.model.GetResourceResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Map of methods for this resource, which is included only if the request uses the embed query option.
- Class com.amazonaws.services.apigateway.model.GetResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Resource.
    - position
```
String position
```
      The position of the next set of results in the current Resources resource to get information about.
    - limit
```
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.
- Class com.amazonaws.services.apigateway.model.GetResourcesResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      Gets the current Resource resource in the collection.
- Class com.amazonaws.services.apigateway.model.GetRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource.
- Class com.amazonaws.services.apigateway.model.GetRestApiResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The date when the API was created, in ISO 8601 format.
    - warnings
```
List<E> warnings
```
- Class com.amazonaws.services.apigateway.model.GetRestApisRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - position
```
String position
```
      The position of the current RestApis resource in the collection to get information about.
    - limit
```
Integer limit
```
      The maximum number of RestApi resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
- Class com.amazonaws.services.apigateway.model.GetRestApisResult extends Object implements Serializable
  - Serialized Fields
    - position
```
String position
```
    - items
```
List<E> items
```
      An array of links to the current page of RestApi resources.
- Class com.amazonaws.services.apigateway.model.GetSdkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi that the SDK will use.
    - stageName
```
String stageName
```
      The name of the Stage that the SDK will use.
    - sdkType
```
String sdkType
```
      The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.
    - parameters
```
Map<K,V> parameters
```
      A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType. For sdkType 'objectivec', a parameter named "classPrefix" is required. For sdkType 'android', parameters named "groupId", "artifactId", "artifactVersion", and "invokerPackage" are required.
- Class com.amazonaws.services.apigateway.model.GetSdkResult extends Object implements Serializable
  - Serialized Fields
    - contentType
```
String contentType
```
      The content-type header value in the HTTP response.
    - contentDisposition
```
String contentDisposition
```
      The content-disposition header value in the HTTP reseponse.
    - body
```
ByteBuffer body
```
      The binary blob response to GetSdk, which contains the generated SDK.
- Class com.amazonaws.services.apigateway.model.GetStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource for the Stage resource to get information about.
    - stageName
```
String stageName
```
      The name of the Stage resource to get information about.
- Class com.amazonaws.services.apigateway.model.GetStageResult extends Object implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
    - stageName
```
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.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
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.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - createdDate
```
Date createdDate
```
      The date and time that the stage was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The date and time that information about the stage was last updated, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.GetStagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The stages' API identifiers.
    - deploymentId
```
String deploymentId
```
      The stages' deployment identifiers.
- Class com.amazonaws.services.apigateway.model.GetStagesResult extends Object implements Serializable
  - Serialized Fields
    - item
```
List<E> item
```
      An individual Stage resource.
- Class com.amazonaws.services.apigateway.model.ImportRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - failOnWarnings
```
Boolean failOnWarnings
```
      A query parameter to indicate whether to rollback the API creation ( true) or not (false) when a warning is encountered. The default value is false.
    - parameters
```
Map<K,V> parameters
```
      Custom header parameters as part of the request.
    - body
```
ByteBuffer body
```
      The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
- Class com.amazonaws.services.apigateway.model.ImportRestApiResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The date when the API was created, in ISO 8601 format.
    - warnings
```
List<E> warnings
```
- Class com.amazonaws.services.apigateway.model.Integration extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
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}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain 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 /.
    - credentials
```
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.
    - requestParameters
```
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.
    - requestTemplates
```
Map<K,V> requestTemplates
```
      Specifies the integration's request templates.
    - cacheNamespace
```
String cacheNamespace
```
      Specifies the integration's cache namespace.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      Specifies the integration's cache key parameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
- Class com.amazonaws.services.apigateway.model.IntegrationResponse extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
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.
    - responseParameters
```
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 MethodResponse. 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}.
    - responseTemplates
```
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.
- Class com.amazonaws.services.apigateway.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
String retryAfterSeconds
```
- Class com.amazonaws.services.apigateway.model.Method extends Object implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The HTTP method.
    - authorizationType
```
String authorizationType
```
      The method's authorization type.
    - authorizerId
```
String authorizerId
```
      Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method requires a valid ApiKey.
    - requestParameters
```
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.
    - requestModels
```
Map<K,V> requestModels
```
      Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
    - methodResponses
```
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.
    - methodIntegration
```
Integration methodIntegration
```
      The method's integration.
- Class com.amazonaws.services.apigateway.model.MethodResponse extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
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.
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.MethodSetting extends Object implements Serializable
  - Serialized Fields
    - metricsEnabled
```
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.
    - loggingLevel
```
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.
    - dataTraceEnabled
```
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.
    - throttlingBurstLimit
```
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.
    - throttlingRateLimit
```
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.
    - cachingEnabled
```
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.
    - cacheTtlInSeconds
```
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.
    - cacheDataEncrypted
```
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.
    - requireAuthorizationForCacheControl
```
Boolean requireAuthorizationForCacheControl
```
      Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl , and the value is a Boolean.
    - unauthorizedCacheControlHeaderStrategy
```
String unauthorizedCacheControlHeaderStrategy
```
      Specifies the strategy on how to handle the unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy , and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.
- Class com.amazonaws.services.apigateway.model.MethodSnapshot extends Object implements Serializable
  - Serialized Fields
    - authorizationType
```
String authorizationType
```
      Specifies the type of authorization used for the method.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method requires a valid ApiKey.
- Class com.amazonaws.services.apigateway.model.Model extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.NotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.PatchOperation extends Object implements Serializable
  - Serialized Fields
    - op
```
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.
    - path
```
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.
    - value
```
String value
```
      The actual value content.
    - from
```
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.
- Class com.amazonaws.services.apigateway.model.PutIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a put integration request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies a put integration request's resource ID.
    - httpMethod
```
String httpMethod
```
      Specifies a put integration request's HTTP method.
    - type
```
String type
```
      Specifies a put integration input's type.
    - integrationHttpMethod
```
String integrationHttpMethod
```
      Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.
    - uri
```
String uri
```
      Specifies a put integration input's Uniform Resource Identifier (URI). When the integration type is HTTP or AWS, this field is required. For integration with Lambda as an AWS service proxy, this value is of the 'arn:aws:apigateway:<region>:lambda:path/2015-03-31/functions/<functionArn>/invocations' format.
    - credentials
```
String credentials
```
      Specifies whether credentials are required for a put integration.
    - requestParameters
```
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.
    - requestTemplates
```
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.
    - cacheNamespace
```
String cacheNamespace
```
      Specifies a put integration input's cache namespace.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      Specifies a put integration input's cache key parameters.
- Class com.amazonaws.services.apigateway.model.PutIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a put integration response request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies a put integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      Specifies a put integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
String selectionPattern
```
      Specifies the selection pattern of a put integration response.
    - responseParameters
```
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}.
    - responseTemplates
```
Map<K,V> responseTemplates
```
      Specifies a put integration response's templates.
- Class com.amazonaws.services.apigateway.model.PutIntegrationResponseResult extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
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.
    - responseParameters
```
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 MethodResponse. 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}.
    - responseTemplates
```
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.
- Class com.amazonaws.services.apigateway.model.PutIntegrationResult extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
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}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain 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 /.
    - credentials
```
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.
    - requestParameters
```
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.
    - requestTemplates
```
Map<K,V> requestTemplates
```
      Specifies the integration's request templates.
    - cacheNamespace
```
String cacheNamespace
```
      Specifies the integration's cache namespace.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      Specifies the integration's cache key parameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
- Class com.amazonaws.services.apigateway.model.PutMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the new Method resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the new Method resource.
    - httpMethod
```
String httpMethod
```
      Specifies the put method request's HTTP method type.
    - authorizationType
```
String authorizationType
```
      Specifies the type of authorization used for the method.
    - authorizerId
```
String authorizerId
```
      Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method required a valid ApiKey.
    - requestParameters
```
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.
    - requestModels
```
Map<K,V> requestModels
```
      Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.PutMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Method resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      The HTTP verb that identifies the Method resource.
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
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.
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.PutMethodResponseResult extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
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.
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.PutMethodResult extends Object implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The HTTP method.
    - authorizationType
```
String authorizationType
```
      The method's authorization type.
    - authorizerId
```
String authorizerId
```
      Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method requires a valid ApiKey.
    - requestParameters
```
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.
    - requestModels
```
Map<K,V> requestModels
```
      Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
    - methodResponses
```
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.
    - methodIntegration
```
Integration methodIntegration
```
      The method's integration.
- Class com.amazonaws.services.apigateway.model.PutRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi to be updated.
    - mode
```
String mode
```
      The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".
    - failOnWarnings
```
Boolean failOnWarnings
```
      A query parameter to indicate whether to rollback the API update ( true) or not (false) when a warning is encountered. The default value is false.
    - parameters
```
Map<K,V> parameters
```
      Custom headers supplied as part of the request.
    - body
```
ByteBuffer body
```
      The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.
- Class com.amazonaws.services.apigateway.model.PutRestApiResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The date when the API was created, in ISO 8601 format.
    - warnings
```
List<E> warnings
```
- Class com.amazonaws.services.apigateway.model.Resource extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Map of methods for this resource, which is included only if the request uses the embed query option.
- Class com.amazonaws.services.apigateway.model.RestApi extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The date when the API was created, in ISO 8601 format.
    - warnings
```
List<E> warnings
```
- Class com.amazonaws.services.apigateway.model.ServiceUnavailableException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
String retryAfterSeconds
```
- Class com.amazonaws.services.apigateway.model.Stage extends Object implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
    - stageName
```
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.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
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.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - createdDate
```
Date createdDate
```
      The date and time that the stage was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The date and time that information about the stage was last updated, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.StageKey extends Object implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      A list of Stage resources that are associated with the ApiKey resource.
    - stageName
```
String stageName
```
      The stage name in the RestApi that the stage key references.
- Class com.amazonaws.services.apigateway.model.TestInvokeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a test invoke authorizer request's RestApi identifier.
    - authorizerId
```
String authorizerId
```
      Specifies a test invoke authorizer request's Authorizer ID.
    - headers
```
Map<K,V> headers
```
      [Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.
    - pathWithQueryString
```
String pathWithQueryString
```
      [Optional] The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
    - body
```
String body
```
      [Optional] The simulated request body of an incoming invocation request.
    - stageVariables
```
Map<K,V> stageVariables
```
      A key-value map of stage variables to simulate an invocation on a deployed Stage.
    - additionalContext
```
Map<K,V> additionalContext
```
      [Optional] A key-value map of additional context variables.
- Class com.amazonaws.services.apigateway.model.TestInvokeAuthorizerResult extends Object implements Serializable
  - Serialized Fields
    - clientStatus
```
Integer clientStatus
```
      The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.
    - log
```
String log
```
      The Amazon API Gateway execution log for the test authorizer request.
    - latency
```
Long latency
```
      The execution latency of the test authorizer request
    - principalId
```
String principalId
```
      The principal identity returned by the Authorizer
    - policy
```
String policy
```
      The policy JSON document returned by the Authorizer
    - authorization
```
Map<K,V> authorization
```
- Class com.amazonaws.services.apigateway.model.TestInvokeMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies a test invoke method request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies a test invoke method request's resource ID.
    - httpMethod
```
String httpMethod
```
      Specifies a test invoke method request's HTTP method.
    - pathWithQueryString
```
String pathWithQueryString
```
      The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
    - body
```
String body
```
      The simulated request body of an incoming invocation request.
    - headers
```
Map<K,V> headers
```
      A key-value map of headers to simulate an incoming invocation request.
    - clientCertificateId
```
String clientCertificateId
```
      A ClientCertificate identifier to use in the test invocation. API Gateway will use use the certificate when making the HTTPS request to the defined backend endpoint.
    - stageVariables
```
Map<K,V> stageVariables
```
      A key-value map of stage variables to simulate an invocation on a deployed Stage.
- Class com.amazonaws.services.apigateway.model.TestInvokeMethodResult extends Object implements Serializable
  - Serialized Fields
    - status
```
Integer status
```
      The HTTP status code.
    - body
```
String body
```
      The body of HTTP response.
    - headers
```
Map<K,V> headers
```
      The headers of HTTP response.
    - log
```
String log
```
      The Amazon API Gateway execution log for the test invoke request.
    - latency
```
Long latency
```
      The execution latency of the test invoke request.
- Class com.amazonaws.services.apigateway.model.ThrottleSettings extends Object implements Serializable
  - Serialized Fields
    - burstLimit
```
Integer burstLimit
```
      Returns the burstLimit when ThrottleSettings is called.
    - rateLimit
```
Double rateLimit
```
      Returns the rateLimit when ThrottleSettings is called.
- Class com.amazonaws.services.apigateway.model.TooManyRequestsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
String retryAfterSeconds
```
- Class com.amazonaws.services.apigateway.model.UnauthorizedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.apigateway.model.UpdateAccountRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateAccountResult extends Object implements Serializable
  - Serialized Fields
    - cloudwatchRoleArn
```
String cloudwatchRoleArn
```
      Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
    - throttleSettings
```
ThrottleSettings throttleSettings
```
      Specifies the application programming interface (API) throttle settings for the current Account resource.
- Class com.amazonaws.services.apigateway.model.UpdateApiKeyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - apiKey
```
String apiKey
```
      The identifier of the ApiKey resource to be updated.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateApiKeyResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the API Key.
    - name
```
String name
```
      The name of the API Key.
    - description
```
String description
```
      The description of the API Key.
    - enabled
```
Boolean enabled
```
      Specifies whether the API Key can be used by callers.
    - stageKeys
```
List<E> stageKeys
```
      A list of Stage resources that are associated with the ApiKey resource.
    - createdDate
```
Date createdDate
```
      The date when the API Key was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      When the API Key was last updated, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.UpdateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Authorizer resource.
    - authorizerId
```
String authorizerId
```
      The identifier of the Authorizer resource.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateAuthorizerResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the authorizer resource.
    - name
```
String name
```
      [Required] The name of the authorizer.
    - type
```
String type
```
      [Required] The type of the authorizer. Currently, the only valid type is TOKEN.
    - authType
```
String authType
```
      Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
    - authorizerUri
```
String authorizerUri
```
      [Required] Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI. The URI should be of the form arn:aws:apigateway:{region}:lambda:path/{service_api}. Region is used to determine the right endpoint. In this case, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations
    - authorizerCredentials
```
String authorizerCredentials
```
      Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
    - identitySource
```
String identitySource
```
      [Required] The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
    - identityValidationExpression
```
String identityValidationExpression
```
      A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
    - authorizerResultTtlInSeconds
```
Integer authorizerResultTtlInSeconds
```
      The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- Class com.amazonaws.services.apigateway.model.UpdateBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The domain name of the BasePathMapping resource to change.
    - basePath
```
String basePath
```
      The base path of the BasePathMapping resource to change.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateBasePathMappingResult extends Object implements Serializable
  - Serialized Fields
    - basePath
```
String basePath
```
      The base path name that callers of the API must provide as part of the URL after the domain name.
    - restApiId
```
String restApiId
```
      The name of the API.
    - stage
```
String stage
```
      The name of the API's stage.
- Class com.amazonaws.services.apigateway.model.UpdateClientCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the ClientCertificate resource to be updated.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateClientCertificateResult extends Object implements Serializable
  - Serialized Fields
    - clientCertificateId
```
String clientCertificateId
```
      The identifier of the Client Certificate.
    - description
```
String description
```
      The description of the Client Certificate.
    - pemEncodedCertificate
```
String pemEncodedCertificate
```
      The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .
    - createdDate
```
Date createdDate
```
      The date when the Client Certificate was created, in ISO 8601 format.
    - expirationDate
```
Date expirationDate
```
      The date when the Client Certificate will expire, in ISO 8601 format.
- Class com.amazonaws.services.apigateway.model.UpdateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The replacement identifier of the RestApi resource for the Deployment resource to change information about.
    - deploymentId
```
String deploymentId
```
      The replacment identifier for the Deployment resource to change information about.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateDeploymentResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the deployment resource.
    - description
```
String description
```
      The description for the deployment resource.
    - createdDate
```
Date createdDate
```
      The date and time that the deployment resource was created.
    - apiSummary
```
Map<K,V> apiSummary
```
      Gets a summary of the RestApi at the date and time that the deployment resource was created.
- Class com.amazonaws.services.apigateway.model.UpdateDomainNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource to be changed.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateDomainNameResult extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the DomainName resource.
    - certificateName
```
String certificateName
```
      The name of the certificate.
    - certificateUploadDate
```
Date certificateUploadDate
```
      The date when the certificate was uploaded, in ISO 8601 format.
    - distributionDomainName
```
String distributionDomainName
```
      The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Represents an update integration request's API identifier.
    - resourceId
```
String resourceId
```
      Represents an update integration request's resource identifier.
    - httpMethod
```
String httpMethod
```
      Represents an update integration request's HTTP method.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      Specifies an update integration response request's API identifier.
    - resourceId
```
String resourceId
```
      Specifies an update integration response request's resource identifier.
    - httpMethod
```
String httpMethod
```
      Specifies an update integration response request's HTTP method.
    - statusCode
```
String statusCode
```
      Specifies an update integration response request's status code.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationResponseResult extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      Specifies the status code that is used to map the integration response to an existing MethodResponse.
    - selectionPattern
```
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.
    - responseParameters
```
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 MethodResponse. 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}.
    - responseTemplates
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateIntegrationResult extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.
    - httpMethod
```
String httpMethod
```
      Specifies the integration's HTTP method type.
    - uri
```
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}:{subdomain.service|service}:{path|action}/{service_api}. Region, subdomain 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 /.
    - credentials
```
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.
    - requestParameters
```
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.
    - requestTemplates
```
Map<K,V> requestTemplates
```
      Specifies the integration's request templates.
    - cacheNamespace
```
String cacheNamespace
```
      Specifies the integration's cache namespace.
    - cacheKeyParameters
```
List<E> cacheKeyParameters
```
      Specifies the integration's cache key parameters.
    - integrationResponses
```
Map<K,V> integrationResponses
```
      Specifies the integration's responses.
- Class com.amazonaws.services.apigateway.model.UpdateMethodRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Method resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the Method resource.
    - httpMethod
```
String httpMethod
```
      The HTTP verb that identifies the Method resource.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateMethodResponseRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the MethodResponse resource.
    - resourceId
```
String resourceId
```
      The Resource identifier for the MethodResponse resource.
    - httpMethod
```
String httpMethod
```
      The HTTP verb identifier for the parent Method resource.
    - statusCode
```
String statusCode
```
      The status code identifier for the MethodResponse resource.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateMethodResponseResult extends Object implements Serializable
  - Serialized Fields
    - statusCode
```
String statusCode
```
      The method response's status code.
    - responseParameters
```
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.
    - responseModels
```
Map<K,V> responseModels
```
      Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
- Class com.amazonaws.services.apigateway.model.UpdateMethodResult extends Object implements Serializable
  - Serialized Fields
    - httpMethod
```
String httpMethod
```
      The HTTP method.
    - authorizationType
```
String authorizationType
```
      The method's authorization type.
    - authorizerId
```
String authorizerId
```
      Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
    - apiKeyRequired
```
Boolean apiKeyRequired
```
      Specifies whether the method requires a valid ApiKey.
    - requestParameters
```
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.
    - requestModels
```
Map<K,V> requestModels
```
      Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
    - methodResponses
```
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.
    - methodIntegration
```
Integration methodIntegration
```
      The method's integration.
- Class com.amazonaws.services.apigateway.model.UpdateModelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier under which the model exists.
    - modelName
```
String modelName
```
      The name of the model to update.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateModelResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the model resource.
    - name
```
String name
```
      The name of the model.
    - description
```
String description
```
      The description of the model.
    - schema
```
String schema
```
      The schema for the model. For application/json models, this should be JSON-schema draft v4 model.
    - contentType
```
String contentType
```
      The content-type for the model.
- Class com.amazonaws.services.apigateway.model.UpdateResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The RestApi identifier for the Resource resource.
    - resourceId
```
String resourceId
```
      The identifier of the Resource resource.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateResourceResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The resource's identifier.
    - parentId
```
String parentId
```
      The parent resource's identifier.
    - pathPart
```
String pathPart
```
      The last path segment for this resource.
    - path
```
String path
```
      The full path for this resource.
    - resourceMethods
```
Map<K,V> resourceMethods
```
      Map of methods for this resource, which is included only if the request uses the embed query option.
- Class com.amazonaws.services.apigateway.model.UpdateRestApiRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The ID of the RestApi you want to update.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateRestApiResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
    - name
```
String name
```
      The API's name.
    - description
```
String description
```
      The API's description.
    - createdDate
```
Date createdDate
```
      The date when the API was created, in ISO 8601 format.
    - warnings
```
List<E> warnings
```
- Class com.amazonaws.services.apigateway.model.UpdateStageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - restApiId
```
String restApiId
```
      The identifier of the RestApi resource for the Stage resource to change information about.
    - stageName
```
String stageName
```
      The name of the Stage resource to change information about.
    - patchOperations
```
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.
- Class com.amazonaws.services.apigateway.model.UpdateStageResult extends Object implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The identifier of the Deployment that the stage points to.
    - clientCertificateId
```
String clientCertificateId
```
    - stageName
```
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.
    - description
```
String description
```
      The stage's description.
    - cacheClusterEnabled
```
Boolean cacheClusterEnabled
```
      Specifies whether a cache cluster is enabled for the stage.
    - cacheClusterSize
```
String cacheClusterSize
```
      The size of the cache cluster for the stage, if enabled.
    - cacheClusterStatus
```
String cacheClusterStatus
```
      The status of the cache cluster for the stage, if enabled.
    - methodSettings
```
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.
    - variables
```
Map<K,V> variables
```
      A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    - createdDate
```
Date createdDate
```
      The date and time that the stage was created, in ISO 8601 format.
    - lastUpdatedDate
```
Date lastUpdatedDate
```
      The date and time that information about the stage was last updated, in ISO 8601 format.
Package com.amazonaws.services.autoscaling.model
- Class com.amazonaws.services.autoscaling.model.Activity extends Object implements Serializable
  - Serialized Fields
    - activityId
```
String activityId
```
      The ID of the activity.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - description
```
String description
```
      A friendly, more verbose description of the activity.
    - cause
```
String cause
```
      The reason the activity began.
    - startTime
```
Date startTime
```
      The start time of the activity.
    - endTime
```
Date endTime
```
      The end time of the activity.
    - statusCode
```
String statusCode
```
      The current status of the activity.
    - statusMessage
```
String statusMessage
```
      A friendly, more verbose description of the activity status.
    - progress
```
Integer progress
```
      A value between 0 and 100 that indicates the progress of the activity.
    - details
```
String details
```
      The details about the activity.
- Class com.amazonaws.services.autoscaling.model.AdjustmentType extends Object implements Serializable
  - Serialized Fields
    - adjustmentType
```
String adjustmentType
```
      The policy adjustment type. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
- Class com.amazonaws.services.autoscaling.model.Alarm extends Object implements Serializable
  - Serialized Fields
    - alarmName
```
String alarmName
```
      The name of the alarm.
    - alarmARN
```
String alarmARN
```
      The Amazon Resource Name (ARN) of the alarm.
- Class com.amazonaws.services.autoscaling.model.AlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.AttachInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more EC2 instance IDs.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
- Class com.amazonaws.services.autoscaling.model.AttachLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - loadBalancerNames
```
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames
```
      One or more load balancer names.
- Class com.amazonaws.services.autoscaling.model.AttachLoadBalancersResult extends Object implements Serializable
- Class com.amazonaws.services.autoscaling.model.AutoScalingGroup extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - autoScalingGroupARN
```
String autoScalingGroupARN
```
      The Amazon Resource Name (ARN) of the group.
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the associated launch configuration.
    - minSize
```
Integer minSize
```
      The minimum size of the group.
    - maxSize
```
Integer maxSize
```
      The maximum size of the group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The desired size of the group.
    - defaultCooldown
```
Integer defaultCooldown
```
      The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.
    - availabilityZones
```
com.amazonaws.internal.SdkInternalList<T> availabilityZones
```
      One or more Availability Zones for the group.
    - loadBalancerNames
```
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames
```
      One or more load balancers associated with the group.
    - healthCheckType
```
String healthCheckType
```
      The service to use for the health checks. The valid values are EC2 and ELB.
    - healthCheckGracePeriod
```
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.
    - instances
```
com.amazonaws.internal.SdkInternalList<T> instances
```
      The EC2 instances associated with the group.
    - createdTime
```
Date createdTime
```
      The date and time the group was created.
    - suspendedProcesses
```
com.amazonaws.internal.SdkInternalList<T> suspendedProcesses
```
      The suspended processes associated with the group.
    - placementGroup
```
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.
    - vPCZoneIdentifier
```
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.
    - enabledMetrics
```
com.amazonaws.internal.SdkInternalList<T> enabledMetrics
```
      The metrics enabled for the group.
    - status
```
String status
```
      The current state of the group when DeleteAutoScalingGroup is in progress.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      The tags for the group.
    - terminationPolicies
```
com.amazonaws.internal.SdkInternalList<T> terminationPolicies
```
      The termination policies for the group.
    - newInstancesProtectedFromScaleIn
```
Boolean newInstancesProtectedFromScaleIn
```
      Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
- Class com.amazonaws.services.autoscaling.model.AutoScalingInstanceDetails extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group associated with the instance.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the instance.
    - lifecycleState
```
String lifecycleState
```
      The lifecycle state for the instance. For more information, see Auto Scaling Instance States in the Auto Scaling Developer Guide.
    - healthStatus
```
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.
    - launchConfigurationName
```
String launchConfigurationName
```
      The launch configuration associated with the instance.
    - protectedFromScaleIn
```
Boolean protectedFromScaleIn
```
      Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
- Class com.amazonaws.services.autoscaling.model.BlockDeviceMapping extends Object implements Serializable
  - Serialized Fields
    - virtualName
```
String virtualName
```
      The name of the virtual device (for example, ephemeral0).
    - deviceName
```
String deviceName
```
      The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh).
    - ebs
```
Ebs ebs
```
      The information about the Amazon EBS volume.
    - noDevice
```
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.
- Class com.amazonaws.services.autoscaling.model.CompleteLifecycleActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group for the lifecycle hook.
    - lifecycleActionToken
```
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.
    - lifecycleActionResult
```
String lifecycleActionResult
```
      The action for the group to take. This parameter can be either CONTINUE or ABANDON.
    - instanceId
```
String instanceId
```
- Class com.amazonaws.services.autoscaling.model.CompleteLifecycleActionResult extends Object implements Serializable
- Class com.amazonaws.services.autoscaling.model.CreateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group. This name must be unique within the scope of your AWS account.
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration. Alternatively, use the InstanceId parameter to specify an EC2 instance instead of a launch configuration.
    - instanceId
```
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.
    - minSize
```
Integer minSize
```
      The minimum size of the group.
    - maxSize
```
Integer maxSize
```
      The maximum size of the group.
    - desiredCapacity
```
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.
    - defaultCooldown
```
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.
    - availabilityZones
```
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.
    - loadBalancerNames
```
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.
    - healthCheckType
```
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.
    - healthCheckGracePeriod
```
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.
    - placementGroup
```
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.
    - vPCZoneIdentifier
```
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.
    - terminationPolicies
```
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.
    - newInstancesProtectedFromScaleIn
```
Boolean newInstancesProtectedFromScaleIn
```
      Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
    - tags
```
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.
- Class com.amazonaws.services.autoscaling.model.CreateLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration. This name must be unique within the scope of your AWS account.
    - imageId
```
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.
    - keyName
```
String keyName
```
      The name of the key pair. For more information, see Amazon EC2 Key Pairs in the Amazon Elastic Compute Cloud User Guide.
    - securityGroups
```
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.
    - classicLinkVPCId
```
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.
    - classicLinkVPCSecurityGroups
```
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.
    - userData
```
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.
    - instanceId
```
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.
    - instanceType
```
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.
    - kernelId
```
String kernelId
```
      The ID of the kernel associated with the AMI.
    - ramdiskId
```
String ramdiskId
```
      The ID of the RAM disk associated with the AMI.
    - blockDeviceMappings
```
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 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.
    - spotPrice
```
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.
    - iamInstanceProfile
```
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.
    - ebsOptimized
```
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.
    - associatePublicIpAddress
```
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.
    - placementTenancy
```
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
- Class com.amazonaws.services.autoscaling.model.CreateOrUpdateTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      One or more tags.
- Class com.amazonaws.services.autoscaling.model.DeleteAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group to delete.
    - forceDelete
```
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.
- Class com.amazonaws.services.autoscaling.model.DeleteLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration.
- Class com.amazonaws.services.autoscaling.model.DeleteLifecycleHookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group for the lifecycle hook.
- Class com.amazonaws.services.autoscaling.model.DeleteLifecycleHookResult extends Object implements Serializable
- Class com.amazonaws.services.autoscaling.model.DeleteNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - topicARN
```
String topicARN
```
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
- Class com.amazonaws.services.autoscaling.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - policyName
```
String policyName
```
      The name or Amazon Resource Name (ARN) of the policy.
- Class com.amazonaws.services.autoscaling.model.DeleteScheduledActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - scheduledActionName
```
String scheduledActionName
```
      The name of the action to delete.
- Class com.amazonaws.services.autoscaling.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tags
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsResult extends Object implements Serializable
  - Serialized Fields
    - maxNumberOfAutoScalingGroups
```
Integer maxNumberOfAutoScalingGroups
```
      The maximum number of groups allowed for your AWS account. The default limit is 20 per region.
    - maxNumberOfLaunchConfigurations
```
Integer maxNumberOfLaunchConfigurations
```
      The maximum number of launch configurations allowed for your AWS account. The default limit is 100 per region.
    - numberOfAutoScalingGroups
```
Integer numberOfAutoScalingGroups
```
      The current number of groups for your AWS account.
    - numberOfLaunchConfigurations
```
Integer numberOfLaunchConfigurations
```
      The current number of launch configurations for your AWS account.
- Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesResult extends Object implements Serializable
  - Serialized Fields
    - adjustmentTypes
```
com.amazonaws.internal.SdkInternalList<T> adjustmentTypes
```
      The policy adjustment types.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupNames
```
com.amazonaws.internal.SdkInternalList<T> autoScalingGroupNames
```
      The group names.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsResult extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroups
```
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
```
      The groups.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
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.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesResult extends Object implements Serializable
  - Serialized Fields
    - autoScalingInstances
```
com.amazonaws.internal.SdkInternalList<T> autoScalingInstances
```
      The instances.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesResult extends Object implements Serializable
  - Serialized Fields
    - autoScalingNotificationTypes
```
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
- Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - launchConfigurationNames
```
com.amazonaws.internal.SdkInternalList<T> launchConfigurationNames
```
      The launch configuration names.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call. The default is 100.
- Class com.amazonaws.services.autoscaling.model.DescribeLaunchConfigurationsResult extends Object implements Serializable
  - Serialized Fields
    - launchConfigurations
```
com.amazonaws.internal.SdkInternalList<T> launchConfigurations
```
      The launch configurations.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHooksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - lifecycleHookNames
```
com.amazonaws.internal.SdkInternalList<T> lifecycleHookNames
```
      The names of one or more lifecycle hooks.
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHooksResult extends Object implements Serializable
  - Serialized Fields
    - lifecycleHooks
```
com.amazonaws.internal.SdkInternalList<T> lifecycleHooks
```
      The lifecycle hooks for the specified group.
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHookTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHookTypesResult extends Object implements Serializable
  - Serialized Fields
    - lifecycleHookTypes
```
com.amazonaws.internal.SdkInternalList<T> lifecycleHookTypes
```
      One or more of the following notification types:
      
      autoscaling:EC2_INSTANCE_LAUNCHING
      
      autoscaling:EC2_INSTANCE_TERMINATING
- Class com.amazonaws.services.autoscaling.model.DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call.
- Class com.amazonaws.services.autoscaling.model.DescribeLoadBalancersResult extends Object implements Serializable
  - Serialized Fields
    - loadBalancers
```
com.amazonaws.internal.SdkInternalList<T> loadBalancers
```
      The load balancers.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesResult extends Object implements Serializable
  - Serialized Fields
    - metrics
```
com.amazonaws.internal.SdkInternalList<T> metrics
```
      One or more metrics.
    - granularities
```
com.amazonaws.internal.SdkInternalList<T> granularities
```
      The granularities for the metrics.
- Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupNames
```
com.amazonaws.internal.SdkInternalList<T> autoScalingGroupNames
```
      The name of the group.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call.
- Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsResult extends Object implements Serializable
  - Serialized Fields
    - notificationConfigurations
```
com.amazonaws.internal.SdkInternalList<T> notificationConfigurations
```
      The notification configurations.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribePoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - policyNames
```
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.
    - policyTypes
```
com.amazonaws.internal.SdkInternalList<T> policyTypes
```
      One or more policy types. Valid values are SimpleScaling and StepScaling.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to be returned with each call.
- Class com.amazonaws.services.autoscaling.model.DescribePoliciesResult extends Object implements Serializable
  - Serialized Fields
    - scalingPolicies
```
com.amazonaws.internal.SdkInternalList<T> scalingPolicies
```
      The scaling policies.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - activityIds
```
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.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
- Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesResult extends Object implements Serializable
  - Serialized Fields
    - activities
```
com.amazonaws.internal.SdkInternalList<T> activities
```
      The scaling activities.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesResult extends Object implements Serializable
  - Serialized Fields
    - processes
```
com.amazonaws.internal.SdkInternalList<T> processes
```
      The names of the process types.
- Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - scheduledActionNames
```
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.
    - startTime
```
Date startTime
```
      The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    - endTime
```
Date endTime
```
      The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call.
- Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsResult extends Object implements Serializable
  - Serialized Fields
    - scheduledUpdateGroupActions
```
com.amazonaws.internal.SdkInternalList<T> scheduledUpdateGroupActions
```
      The scheduled actions.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      A filter used to scope the tags to return.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a previous call.)
    - maxRecords
```
Integer maxRecords
```
      The maximum number of items to return with this call.
- Class com.amazonaws.services.autoscaling.model.DescribeTagsResult extends Object implements Serializable
  - Serialized Fields
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      The tags.
    - nextToken
```
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.
- Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesResult extends Object implements Serializable
  - Serialized Fields
    - terminationPolicyTypes
```
com.amazonaws.internal.SdkInternalList<T> terminationPolicyTypes
```
      The termination policies supported by Auto Scaling ( OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, and Default).
- Class com.amazonaws.services.autoscaling.model.DetachInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - shouldDecrementDesiredCapacity
```
Boolean shouldDecrementDesiredCapacity
```
      If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.
- Class com.amazonaws.services.autoscaling.model.DetachInstancesResult extends Object implements Serializable
  - Serialized Fields
    - activities
```
com.amazonaws.internal.SdkInternalList<T> activities
```
      The activities related to detaching the instances from the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.DetachLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - loadBalancerNames
```
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames
```
      One or more load balancer names.
- Class com.amazonaws.services.autoscaling.model.DetachLoadBalancersResult extends Object implements Serializable
- Class com.amazonaws.services.autoscaling.model.DisableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name or Amazon Resource Name (ARN) of the group.
    - metrics
```
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
- Class com.amazonaws.services.autoscaling.model.Ebs extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - volumeSize
```
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.
    - volumeType
```
String volumeType
```
      The volume type.
      
      Valid values: standard | io1 | gp2
      
      Default: standard
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether to delete the volume on instance termination.
      
      Default: true
    - iops
```
Integer iops
```
      For Provisioned IOPS (SSD) volumes only. The number of I/O operations per second (IOPS) to provision for the volume.
      
      Default: None
    - encrypted
```
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.
- Class com.amazonaws.services.autoscaling.model.EnabledMetric extends Object implements Serializable
  - Serialized Fields
    - metric
```
String metric
```
      One of the following metrics:
      
      GroupMinSize
      
      GroupMaxSize
      
      GroupDesiredCapacity
      
      GroupInServiceInstances
      
      GroupPendingInstances
      
      GroupStandbyInstances
      
      GroupTerminatingInstances
      
      GroupTotalInstances
    - granularity
```
String granularity
```
      The granularity of the metric. The only valid value is 1Minute.
- Class com.amazonaws.services.autoscaling.model.EnableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name or ARN of the Auto Scaling group.
    - metrics
```
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.
    - granularity
```
String granularity
```
      The granularity to associate with the metrics to collect. The only valid value is 1Minute.
- Class com.amazonaws.services.autoscaling.model.EnterStandbyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instances to move into Standby mode. You must specify at least one instance ID.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - shouldDecrementDesiredCapacity
```
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.
- Class com.amazonaws.services.autoscaling.model.EnterStandbyResult extends Object implements Serializable
  - Serialized Fields
    - activities
```
com.amazonaws.internal.SdkInternalList<T> activities
```
      The activities related to moving instances into Standby mode.
- Class com.amazonaws.services.autoscaling.model.ExecutePolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name or Amazon Resource Name (ARN) of the Auto Scaling group.
    - policyName
```
String policyName
```
      The name or ARN of the policy.
    - honorCooldown
```
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.
    - metricValue
```
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.
    - breachThreshold
```
Double breachThreshold
```
      The breach threshold for the alarm.
      
      This parameter is required if the policy type is StepScaling and not supported otherwise.
- Class com.amazonaws.services.autoscaling.model.ExitStandbyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs. You must specify at least one instance ID.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.ExitStandbyResult extends Object implements Serializable
  - Serialized Fields
    - activities
```
com.amazonaws.internal.SdkInternalList<T> activities
```
      The activities related to moving instances out of Standby mode.
- Class com.amazonaws.services.autoscaling.model.Filter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the filter. The valid values are: "auto-scaling-group", "key", "value", and "propagate-at-launch".
    - values
```
com.amazonaws.internal.SdkInternalList<T> values
```
      The value of the filter.
- Class com.amazonaws.services.autoscaling.model.Instance extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone in which the instance is running.
    - lifecycleState
```
String lifecycleState
```
      A description of the current lifecycle state. Note that the Quarantined state is not used.
    - healthStatus
```
String healthStatus
```
      The health status of the instance.
    - launchConfigurationName
```
String launchConfigurationName
```
      The launch configuration associated with the instance.
    - protectedFromScaleIn
```
Boolean protectedFromScaleIn
```
      Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
- Class com.amazonaws.services.autoscaling.model.InstanceMonitoring extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      If True, instance monitoring is enabled.
- Class com.amazonaws.services.autoscaling.model.InvalidNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.LaunchConfiguration extends Object implements Serializable
  - Serialized Fields
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration.
    - launchConfigurationARN
```
String launchConfigurationARN
```
      The Amazon Resource Name (ARN) of the launch configuration.
    - imageId
```
String imageId
```
      The ID of the Amazon Machine Image (AMI).
    - keyName
```
String keyName
```
      The name of the key pair.
    - securityGroups
```
com.amazonaws.internal.SdkInternalList<T> securityGroups
```
      The security groups to associate with the instances.
    - classicLinkVPCId
```
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.
    - classicLinkVPCSecurityGroups
```
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.
    - userData
```
String userData
```
      The user data available to the instances.
    - instanceType
```
String instanceType
```
      The instance type for the instances.
    - kernelId
```
String kernelId
```
      The ID of the kernel associated with the AMI.
    - ramdiskId
```
String ramdiskId
```
      The ID of the RAM disk associated with the AMI.
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      A block device mapping, which specifies the block devices for the instance.
    - instanceMonitoring
```
InstanceMonitoring instanceMonitoring
```
      Controls whether instances in this group are launched with detailed monitoring.
    - spotPrice
```
String spotPrice
```
      The price to bid when launching Spot Instances.
    - iamInstanceProfile
```
String iamInstanceProfile
```
      The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.
    - createdTime
```
Date createdTime
```
      The creation date and time for the launch configuration.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Controls whether the instance is optimized for EBS I/O (true ) or not (false).
    - associatePublicIpAddress
```
Boolean associatePublicIpAddress
```
      [EC2-VPC] Indicates whether to assign a public IP address to each instance.
    - placementTenancy
```
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.
- Class com.amazonaws.services.autoscaling.model.LifecycleHook extends Object implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group for the lifecycle hook.
    - lifecycleTransition
```
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.
    - notificationTargetARN
```
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:
      
      Lifecycle action token
      
      User account ID
      
      Name of the Auto Scaling group
      
      Lifecycle hook name
      
      EC2 instance ID
      
      Lifecycle transition
      
      Notification metadata
    - roleARN
```
String roleARN
```
      The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.
    - notificationMetadata
```
String notificationMetadata
```
      Additional information that you want to include any time Auto Scaling sends a message to the notification target.
    - heartbeatTimeout
```
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.
    - globalTimeout
```
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).
    - defaultResult
```
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.
- Class com.amazonaws.services.autoscaling.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.LoadBalancerState extends Object implements Serializable
  - Serialized Fields
    - loadBalancerName
```
String loadBalancerName
```
      The name of the load balancer.
    - state
```
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.
- Class com.amazonaws.services.autoscaling.model.MetricCollectionType extends Object implements Serializable
  - Serialized Fields
    - metric
```
String metric
```
      One of the following metrics:
      
      GroupMinSize
      
      GroupMaxSize
      
      GroupDesiredCapacity
      
      GroupInServiceInstances
      
      GroupPendingInstances
      
      GroupStandbyInstances
      
      GroupTerminatingInstances
      
      GroupTotalInstances
- Class com.amazonaws.services.autoscaling.model.MetricGranularityType extends Object implements Serializable
  - Serialized Fields
    - granularity
```
String granularity
```
      The granularity. The only valid value is 1Minute.
- Class com.amazonaws.services.autoscaling.model.NotificationConfiguration extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - topicARN
```
String topicARN
```
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
    - notificationType
```
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
- Class com.amazonaws.services.autoscaling.model.ProcessType extends Object implements Serializable
  - Serialized Fields
    - processName
```
String processName
```
      One of the following processes:
      
      Launch
      
      Terminate
      
      AddToLoadBalancer
      
      AlarmNotification
      
      AZRebalance
      
      HealthCheck
      
      ReplaceUnhealthy
      
      ScheduledActions
- Class com.amazonaws.services.autoscaling.model.PutLifecycleHookRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group to which you want to assign the lifecycle hook.
    - lifecycleTransition
```
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.
    - roleARN
```
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.
    - notificationTargetARN
```
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:
      
      LifecycleActionToken. The Lifecycle action token.
      
      AccountId. The user account ID.
      
      AutoScalingGroupName. The name of the Auto Scaling group.
      
      LifecycleHookName. The lifecycle hook name.
      
      EC2InstanceId. The EC2 instance ID.
      
      LifecycleTransition. The lifecycle transition.
      
      NotificationMetadata. The notification metadata.
      
      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.
    - notificationMetadata
```
String notificationMetadata
```
      Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.
    - heartbeatTimeout
```
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).
    - defaultResult
```
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.
- Class com.amazonaws.services.autoscaling.model.PutLifecycleHookResult extends Object implements Serializable
- Class com.amazonaws.services.autoscaling.model.PutNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - topicARN
```
String topicARN
```
      The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.
    - notificationTypes
```
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.
- Class com.amazonaws.services.autoscaling.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name or ARN of the group.
    - policyName
```
String policyName
```
      The name of the policy.
    - policyType
```
String policyType
```
      The policy type. Valid values are SimpleScaling and StepScaling. If the policy type is null, the value is treated as SimpleScaling.
    - adjustmentType
```
String adjustmentType
```
      The adjustment type. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
      
      For more information, see Dynamic Scaling in the Auto Scaling Developer Guide.
    - minAdjustmentStep
```
Integer minAdjustmentStep
```
      Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    - minAdjustmentMagnitude
```
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.
    - scalingAdjustment
```
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.
    - cooldown
```
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.
    - metricAggregationType
```
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.
    - stepAdjustments
```
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.
    - estimatedInstanceWarmup
```
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.
- Class com.amazonaws.services.autoscaling.model.PutScalingPolicyResult extends Object implements Serializable
  - Serialized Fields
    - policyARN
```
String policyARN
```
      The Amazon Resource Name (ARN) of the policy.
- Class com.amazonaws.services.autoscaling.model.PutScheduledUpdateGroupActionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name or Amazon Resource Name (ARN) of the Auto Scaling group.
    - scheduledActionName
```
String scheduledActionName
```
      The name of this scaling action.
    - time
```
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.
    - startTime
```
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.
    - endTime
```
Date endTime
```
      The time for this action to end.
    - recurrence
```
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.
    - minSize
```
Integer minSize
```
      The minimum size for the Auto Scaling group.
    - maxSize
```
Integer maxSize
```
      The maximum size for the Auto Scaling group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of EC2 instances that should be running in the group.
- Class com.amazonaws.services.autoscaling.model.RecordLifecycleActionHeartbeatRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lifecycleHookName
```
String lifecycleHookName
```
      The name of the lifecycle hook.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group for the hook.
    - lifecycleActionToken
```
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.
    - instanceId
```
String instanceId
```
- Class com.amazonaws.services.autoscaling.model.RecordLifecycleActionHeartbeatResult extends Object implements Serializable
- Class com.amazonaws.services.autoscaling.model.ResourceContentionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.ResourceInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.ResumeProcessesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name or Amazon Resource Name (ARN) of the Auto Scaling group.
    - scalingProcesses
```
com.amazonaws.internal.SdkInternalList<T> scalingProcesses
```
      One or more of the following processes:
      
      Launch
      
      Terminate
      
      HealthCheck
      
      ReplaceUnhealthy
      
      AZRebalance
      
      AlarmNotification
      
      ScheduledActions
      
      AddToLoadBalancer
- Class com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.autoscaling.model.ScalingPolicy extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group associated with this scaling policy.
    - policyName
```
String policyName
```
      The name of the scaling policy.
    - policyARN
```
String policyARN
```
      The Amazon Resource Name (ARN) of the policy.
    - policyType
```
String policyType
```
      The policy type. Valid values are SimpleScaling and StepScaling.
    - adjustmentType
```
String adjustmentType
```
      The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    - minAdjustmentStep
```
Integer minAdjustmentStep
```
      Available for backward compatibility. Use MinAdjustmentMagnitude instead.
    - minAdjustmentMagnitude
```
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.
    - scalingAdjustment
```
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.
    - cooldown
```
Integer cooldown
```
      The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.
    - stepAdjustments
```
com.amazonaws.internal.SdkInternalList<T> stepAdjustments
```
      A set of adjustments that enable you to scale based on the size of the alarm breach.
    - metricAggregationType
```
String metricAggregationType
```
      The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.
    - estimatedInstanceWarmup
```
Integer estimatedInstanceWarmup
```
      The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.
    - alarms
```
com.amazonaws.internal.SdkInternalList<T> alarms
```
      The CloudWatch alarms related to the policy.
- Class com.amazonaws.services.autoscaling.model.ScheduledUpdateGroupAction extends Object implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - scheduledActionName
```
String scheduledActionName
```
      The name of the scheduled action.
    - scheduledActionARN
```
String scheduledActionARN
```
      The Amazon Resource Name (ARN) of the scheduled action.
    - time
```
Date time
```
      This parameter is deprecated; use StartTime instead.
    - startTime
```
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.
    - endTime
```
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.
    - recurrence
```
String recurrence
```
      The recurring schedule for the action.
    - minSize
```
Integer minSize
```
      The minimum size of the group.
    - maxSize
```
Integer maxSize
```
      The maximum size of the group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of instances you prefer to maintain in the group.
- Class com.amazonaws.services.autoscaling.model.SetDesiredCapacityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - desiredCapacity
```
Integer desiredCapacity
```
      The number of EC2 instances that should be running in the Auto Scaling group.
    - honorCooldown
```
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.
- Class com.amazonaws.services.autoscaling.model.SetInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the EC2 instance.
    - healthStatus
```
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.
    - shouldRespectGracePeriod
```
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.
- Class com.amazonaws.services.autoscaling.model.SetInstanceProtectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs.
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the group.
    - protectedFromScaleIn
```
Boolean protectedFromScaleIn
```
      Indicates whether the instance is protected from termination by Auto Scaling when scaling in.
- Class com.amazonaws.services.autoscaling.model.SetInstanceProtectionResult extends Object implements Serializable
- Class com.amazonaws.services.autoscaling.model.StepAdjustment extends Object implements Serializable
  - Serialized Fields
    - metricIntervalLowerBound
```
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.
    - metricIntervalUpperBound
```
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.
    - scalingAdjustment
```
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.
- Class com.amazonaws.services.autoscaling.model.SuspendedProcess extends Object implements Serializable
  - Serialized Fields
    - processName
```
String processName
```
      The name of the suspended process.
    - suspensionReason
```
String suspensionReason
```
      The reason that the process was suspended.
- Class com.amazonaws.services.autoscaling.model.SuspendProcessesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name or Amazon Resource Name (ARN) of the Auto Scaling group.
    - scalingProcesses
```
com.amazonaws.internal.SdkInternalList<T> scalingProcesses
```
      One or more of the following processes:
      
      Launch
      
      Terminate
      
      HealthCheck
      
      ReplaceUnhealthy
      
      AZRebalance
      
      AlarmNotification
      
      ScheduledActions
      
      AddToLoadBalancer
- Class com.amazonaws.services.autoscaling.model.Tag extends Object implements Serializable
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The name of the group.
    - resourceType
```
String resourceType
```
      The type of resource. The only supported value is auto-scaling-group.
    - key
```
String key
```
      The tag key.
    - value
```
String value
```
      The tag value.
    - propagateAtLaunch
```
Boolean propagateAtLaunch
```
      Determines whether the tag is added to new instances as they are launched in the group.
- Class com.amazonaws.services.autoscaling.model.TagDescription extends Object implements Serializable
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The name of the group.
    - resourceType
```
String resourceType
```
      The type of resource. The only supported value is auto-scaling-group.
    - key
```
String key
```
      The tag key.
    - value
```
String value
```
      The tag value.
    - propagateAtLaunch
```
Boolean propagateAtLaunch
```
      Determines whether the tag is added to new instances as they are launched in the group.
- Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the EC2 instance.
    - shouldDecrementDesiredCapacity
```
Boolean shouldDecrementDesiredCapacity
```
      If true, terminating the instance also decrements the size of the Auto Scaling group.
- Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupResult extends Object implements Serializable
  - Serialized Fields
    - activity
```
Activity activity
```
      A scaling activity.
- Class com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoScalingGroupName
```
String autoScalingGroupName
```
      The name of the Auto Scaling group.
    - launchConfigurationName
```
String launchConfigurationName
```
      The name of the launch configuration.
    - minSize
```
Integer minSize
```
      The minimum size of the Auto Scaling group.
    - maxSize
```
Integer maxSize
```
      The maximum size of the Auto Scaling group.
    - desiredCapacity
```
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.
    - defaultCooldown
```
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.
    - availabilityZones
```
com.amazonaws.internal.SdkInternalList<T> availabilityZones
```
      One or more Availability Zones for the group.
    - healthCheckType
```
String healthCheckType
```
      The service to use for the health checks. The valid values are EC2 and ELB.
    - healthCheckGracePeriod
```
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.
    - placementGroup
```
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.
    - vPCZoneIdentifier
```
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.
    - terminationPolicies
```
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.
    - newInstancesProtectedFromScaleIn
```
Boolean newInstancesProtectedFromScaleIn
```
      Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.
Package com.amazonaws.services.certificatemanager.model
- Class com.amazonaws.services.certificatemanager.model.CertificateDetail extends Object implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      Amazon Resource Name (ARN) of the certificate. This is of the form:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    - domainName
```
String domainName
```
      Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
    - subjectAlternativeNames
```
List<E> subjectAlternativeNames
```
      One or more domain names (subject alternative names) included in the certificate request. After the certificate is issued, this list includes the domain names bound to the public key contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
    - domainValidationOptions
```
List<E> domainValidationOptions
```
      References a DomainValidation structure that contains the domain name in the certificate and the email address that can be used for validation.
    - serial
```
String serial
```
      String that contains the serial number of the certificate.
    - subject
```
String subject
```
      The X.500 distinguished name of the entity associated with the public key contained in the certificate.
    - issuer
```
String issuer
```
      The X.500 distinguished name of the CA that issued and signed the certificate.
    - createdAt
```
Date createdAt
```
      Time at which the certificate was requested.
    - issuedAt
```
Date issuedAt
```
      Time at which the certificate was issued.
    - status
```
String status
```
      A CertificateStatus enumeration value that can contain one of the following:
      
      PENDING_VALIDATION
      
      ISSUED
      
      INACTIVE
      
      EXPIRED
      
      REVOKED
      
      FAILED
      
      VALIDATION_TIMED_OUT
    - revokedAt
```
Date revokedAt
```
      The time, if any, at which the certificate was revoked. This value exists only if the certificate has been revoked.
    - revocationReason
```
String revocationReason
```
      A RevocationReason enumeration value that indicates why the certificate was revoked. This value exists only if the certificate has been revoked. This can be one of the following vales:
      
      UNSPECIFIED
      
      KEY_COMPROMISE
      
      CA_COMPROMISE
      
      AFFILIATION_CHANGED
      
      SUPERCEDED
      
      CESSATION_OF_OPERATION
      
      CERTIFICATE_HOLD
      
      REMOVE_FROM_CRL
      
      PRIVILEGE_WITHDRAWN
      
      A_A_COMPROMISE
    - notBefore
```
Date notBefore
```
      Time before which the certificate is not valid.
    - notAfter
```
Date notAfter
```
      Time after which the certificate is not valid.
    - keyAlgorithm
```
String keyAlgorithm
```
      Asymmetric algorithm used to generate the public and private key pair. Currently the only supported value is RSA_2048.
    - signatureAlgorithm
```
String signatureAlgorithm
```
      Algorithm used to generate a signature. Currently the only supported value is SHA256WITHRSA.
    - inUseBy
```
List<E> inUseBy
```
      List that identifies ARNs that are using the certificate. A single ACM Certificate can be used by multiple AWS resources.
- Class com.amazonaws.services.certificatemanager.model.CertificateSummary extends Object implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      Amazon Resource Name (ARN) of the certificate. This is of the form:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
    - domainName
```
String domainName
```
      Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
- Class com.amazonaws.services.certificatemanager.model.DeleteCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      String that contains the ARN of the ACM Certificate to be deleted. This must be of the form:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
- Class com.amazonaws.services.certificatemanager.model.DescribeCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      String that contains an ACM Certificate ARN. The ARN must be of the form:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
- Class com.amazonaws.services.certificatemanager.model.DescribeCertificateResult extends Object implements Serializable
  - Serialized Fields
    - certificate
```
CertificateDetail certificate
```
      Contains a CertificateDetail structure that lists the fields of an ACM Certificate.
- Class com.amazonaws.services.certificatemanager.model.DomainValidation extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Fully Qualified Domain Name (FQDN) of the form www.example.com or example.com
    - validationEmails
```
List<E> validationEmails
```
      A list of contact address for the domain registrant.
    - validationDomain
```
String validationDomain
```
      The base validation domain that acts as the suffix of the email addresses that are used to send the emails.
- Class com.amazonaws.services.certificatemanager.model.DomainValidationOption extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Fully Qualified Domain Name (FQDN) of the certificate being requested.
    - validationDomain
```
String validationDomain
```
      The domain to which validation email is sent. This is the base validation domain that will act as the suffix of the email addresses. This must be the same as the DomainName value or a superdomain of the DomainName value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS for the base domain and the following five addresses:
      
      [email protected]
      
      [email protected]
      
      [email protected]
      
      [email protected]
      
      [email protected]
- Class com.amazonaws.services.certificatemanager.model.GetCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      String that contains a certificate ARN in the following format:
      
      arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
      
      For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces.
- Class com.amazonaws.services.certificatemanager.model.GetCertificateResult extends Object implements Serializable
  - Serialized Fields
    - certificate
```
String certificate
```
      String that contains the ACM Certificate represented by the ARN specified at input.
    - certificateChain
```
String certificateChain
```
      The certificate chain that contains the root certificate issued by the certificate authority (CA).
- Class com.amazonaws.services.certificatemanager.model.InvalidArnException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.certificatemanager.model.InvalidDomainValidationOptionsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.certificatemanager.model.InvalidStateException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.certificatemanager.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.certificatemanager.model.ListCertificatesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateStatuses
```
List<E> certificateStatuses
```
      Identifies the statuses of the ACM Certificates for which you want to retrieve the ARNs. This can be one or more of the following values:
      
      PENDING_VALIDATION
      
      ISSUED
      
      INACTIVE
      
      EXPIRED
      
      VALIDATION_TIMED_OUT
      
      REVOKED
      
      FAILED
    - nextToken
```
String nextToken
```
      String that contains an opaque marker of the next ACM Certificate ARN to be displayed. Use this parameter when paginating results, and only in a subsequent request after you've received a response where the results have been truncated. Set it to an empty string the first time you call this action, and set it to the value of the NextToken element you receive in the response object for subsequent calls.
    - maxItems
```
Integer maxItems
```
      Specify this parameter when paginating results to indicate the maximum number of ACM Certificates that you want to display for each response. If there are additional certificates beyond the maximum you specify, use the NextToken value in your next call to the ListCertificates action.
- Class com.amazonaws.services.certificatemanager.model.ListCertificatesResult extends Object implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      If the list has been truncated, this value is present and should be used for the NextToken input parameter on your next call to ListCertificates.
    - certificateSummaryList
```
List<E> certificateSummaryList
```
      A list of the certificate ARNs.
- Class com.amazonaws.services.certificatemanager.model.RequestCertificateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Fully qualified domain name (FQDN), such as www.example.com, of the site you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.
    - subjectAlternativeNames
```
List<E> subjectAlternativeNames
```
      Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name.
    - idempotencyToken
```
String idempotencyToken
```
      Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.
    - domainValidationOptions
```
List<E> domainValidationOptions
```
      The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for test.example.com and specify DomainValidationOptions of example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:
      
      [email protected]
      
      [email protected]
      
      [email protected]
      
      [email protected]
      
      [email protected]
- Class com.amazonaws.services.certificatemanager.model.RequestCertificateResult extends Object implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      String that contains the ARN of the issued certificate. This must be of the form:
      
      arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
- Class com.amazonaws.services.certificatemanager.model.RequestInProgressException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.certificatemanager.model.ResendValidationEmailRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - certificateArn
```
String certificateArn
```
      String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by RequestCertificate as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request.
      
      The ARN must be of the form:
      
      arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
    - domain
```
String domain
```
      The Fully Qualified Domain Name (FQDN) of the certificate that needs to be validated.
    - validationDomain
```
String validationDomain
```
      The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the Domain value or a superdomain of the Domain value. For example, if you requested a certificate for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:
      
      [email protected]
      
      [email protected]
      
      [email protected]
      
      [email protected]
      
      [email protected]
- Class com.amazonaws.services.certificatemanager.model.ResourceInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.certificatemanager.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.cloudformation.model
- Class com.amazonaws.services.cloudformation.model.AccountLimit extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the account limit. Currently, the only account limit is StackLimit.
    - value
```
Integer value
```
      The value that is associated with the account limit name.
- Class com.amazonaws.services.cloudformation.model.AlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudformation.model.CancelUpdateStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack.
- Class com.amazonaws.services.cloudformation.model.Change extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.
    - resourceChange
```
ResourceChange resourceChange
```
      A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.
- Class com.amazonaws.services.cloudformation.model.ChangeSetNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudformation.model.ChangeSetSummary extends Object implements Serializable
  - Serialized Fields
    - stackId
```
String stackId
```
      The ID of the stack with which the change set is associated.
    - stackName
```
String stackName
```
      The name of the stack with which the change set is associated.
    - changeSetId
```
String changeSetId
```
      The ID of the change set.
    - changeSetName
```
String changeSetName
```
      The name of the change set.
    - status
```
String status
```
      The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
    - statusReason
```
String statusReason
```
      A description of the change set's status. For example, if your change set is in the FAILED state, AWS CloudFormation shows the error message.
    - creationTime
```
Date creationTime
```
      The start time when the change set was created, in UTC.
    - description
```
String description
```
      Descriptive information about the change set.
- Class com.amazonaws.services.cloudformation.model.ContinueUpdateRollbackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique ID of the stack that you want to continue rolling back.
- Class com.amazonaws.services.cloudformation.model.ContinueUpdateRollbackResult extends Object implements Serializable
- Class com.amazonaws.services.cloudformation.model.CreateChangeSetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.
    - templateBody
```
String templateBody
```
      A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.
      
      Conditional: You must specify only TemplateBody or TemplateURL.
    - templateURL
```
String templateURL
```
      The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.
      
      Conditional: You must specify only TemplateBody or TemplateURL.
    - usePreviousTemplate
```
Boolean usePreviousTemplate
```
      Whether to reuse the template that is associated with the stack to create the change set.
    - parameters
```
com.amazonaws.internal.SdkInternalList<T> parameters
```
      A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.
    - capabilities
```
com.amazonaws.internal.SdkInternalList<T> capabilities
```
      A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. 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 all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns an InsufficientCapabilities error.
    - resourceTypes
```
com.amazonaws.internal.SdkInternalList<T> resourceTypes
```
      The template resource types that you have permissions to work with if you execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
      
      If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide.
    - notificationARNs
```
com.amazonaws.internal.SdkInternalList<T> notificationARNs
```
      The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon SNS) topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to resources in the stack. You can specify a maximum of 10 tags.
    - changeSetName
```
String changeSetName
```
      The name of the change set. The name must be unique among all change sets that are associated with the specified stack.
      
      A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters.
    - clientToken
```
String clientToken
```
      A unique identifier for this CreateChangeSet request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another change set with the same name. You might retry CreateChangeSet requests to ensure that AWS CloudFormation successfully received them.
    - description
```
String description
```
      A description to help you identify this change set.
- Class com.amazonaws.services.cloudformation.model.CreateChangeSetResult extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The Amazon Resource Name (ARN) of the change set.
- Class com.amazonaws.services.cloudformation.model.CreateStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
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.
      A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters.
    - templateBody
```
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.
    - 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, 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.
    - parameters
```
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.
    - disableRollback
```
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
    - timeoutInMinutes
```
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.
    - notificationARNs
```
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).
    - capabilities
```
com.amazonaws.internal.SdkInternalList<T> capabilities
```
      A list of capabilities that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. 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 all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns an InsufficientCapabilities error.
    - resourceTypes
```
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.
    - onFailure
```
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
    - stackPolicyBody
```
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.
    - stackPolicyURL
```
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.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.
- Class com.amazonaws.services.cloudformation.model.CreateStackResult extends Object implements Serializable
  - Serialized Fields
    - stackId
```
String stackId
```
      Unique identifier of the stack.
- Class com.amazonaws.services.cloudformation.model.DeleteChangeSetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - changeSetName
```
String changeSetName
```
      The name or Amazon Resource Name (ARN) of the change set that you want to delete.
    - stackName
```
String stackName
```
      If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.
- Class com.amazonaws.services.cloudformation.model.DeleteChangeSetResult extends Object implements Serializable
- Class com.amazonaws.services.cloudformation.model.DeleteStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack.
    - retainResources
```
com.amazonaws.internal.SdkInternalList<T> retainResources
```
      For stacks in the DELETE_FAILED state, a list of resource logical IDs that are associated with the resources you want to retain. During deletion, AWS CloudFormation deletes the stack but does not delete the retained resources.
      
      Retaining resources is useful when you cannot delete a resource, such as a non-empty S3 bucket, but you want to delete the stack.
- Class com.amazonaws.services.cloudformation.model.DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      A string that identifies the next page of limits that you want to retrieve.
- Class com.amazonaws.services.cloudformation.model.DescribeAccountLimitsResult extends Object implements Serializable
  - Serialized Fields
    - accountLimits
```
com.amazonaws.internal.SdkInternalList<T> accountLimits
```
      An account limit structure that contain a list of AWS CloudFormation account limits and their values.
    - nextToken
```
String nextToken
```
      If the output exceeds 1 MB in size, a string that identifies the next page of limits. If no additional page exists, this value is null.
- Class com.amazonaws.services.cloudformation.model.DescribeChangeSetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - changeSetName
```
String changeSetName
```
      The name or Amazon Resource Name (ARN) of the change set that you want to describe.
    - stackName
```
String stackName
```
      If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.
    - nextToken
```
String nextToken
```
      A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.
- Class com.amazonaws.services.cloudformation.model.DescribeChangeSetResult extends Object implements Serializable
  - Serialized Fields
    - changeSetName
```
String changeSetName
```
      The name of the change set.
    - changeSetId
```
String changeSetId
```
      The ARN of the change set.
    - stackId
```
String stackId
```
      The ARN of the stack that is associated with the change set.
    - stackName
```
String stackName
```
      The name of the stack that is associated with the change set.
    - description
```
String description
```
      Information about the change set.
    - parameters
```
com.amazonaws.internal.SdkInternalList<T> parameters
```
      A list of Parameter structures that describes the input parameters and their values used to create the change set. For more information, see the Parameter data type.
    - creationTime
```
Date creationTime
```
      The start time when the change set was created, in UTC.
    - status
```
String status
```
      The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, or FAILED.
    - statusReason
```
String statusReason
```
      A description of the change set's status. For example, if your attempt to create a change set failed, AWS CloudFormation shows the error message.
    - notificationARNs
```
com.amazonaws.internal.SdkInternalList<T> notificationARNs
```
      The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that will be associated with the stack if you execute the change set.
    - capabilities
```
com.amazonaws.internal.SdkInternalList<T> capabilities
```
      If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      If you execute the change set, the tags that will be associated with the stack.
    - changes
```
com.amazonaws.internal.SdkInternalList<T> changes
```
      A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.
    - nextToken
```
String nextToken
```
      If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.
- Class com.amazonaws.services.cloudformation.model.DescribeStackEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
      
      Running stacks: You can specify either the stack's name or its unique stack ID.
      
      Deleted stacks: You must specify the unique stack ID.
      
      Default: There is no default value.
    - nextToken
```
String nextToken
```
      A string that identifies the next page of events that you want to retrieve.
- Class com.amazonaws.services.cloudformation.model.DescribeStackEventsResult extends Object implements Serializable
  - Serialized Fields
    - stackEvents
```
com.amazonaws.internal.SdkInternalList<T> stackEvents
```
      A list of StackEvents structures.
    - nextToken
```
String nextToken
```
      If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.
- Class com.amazonaws.services.cloudformation.model.DescribeStackResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
      
      Running stacks: You can specify either the stack's name or its unique stack ID.
      
      Deleted stacks: You must specify the unique stack ID.
      
      Default: There is no default value.
    - logicalResourceId
```
String logicalResourceId
```
      The logical name of the resource as specified in the template.
      
      Default: There is no default value.
- Class com.amazonaws.services.cloudformation.model.DescribeStackResourceResult extends Object implements Serializable
  - Serialized Fields
    - stackResourceDetail
```
StackResourceDetail stackResourceDetail
```
      A StackResourceDetail structure containing the description of the specified resource in the specified stack.
- Class com.amazonaws.services.cloudformation.model.DescribeStackResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
      
      Running stacks: You can specify either the stack's name or its unique stack ID.
      
      Deleted stacks: You must specify the unique stack ID.
      
      Default: There is no default value.
      
      Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.
    - logicalResourceId
```
String logicalResourceId
```
      The logical name of the resource as specified in the template.
      
      Default: There is no default value.
    - physicalResourceId
```
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.
- Class com.amazonaws.services.cloudformation.model.DescribeStackResourcesResult extends Object implements Serializable
  - Serialized Fields
    - stackResources
```
com.amazonaws.internal.SdkInternalList<T> stackResources
```
      A list of StackResource structures.
- Class com.amazonaws.services.cloudformation.model.DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
      
      Running stacks: You can specify either the stack's name or its unique stack ID.
      
      Deleted stacks: You must specify the unique stack ID.
      
      Default: There is no default value.
    - nextToken
```
String nextToken
```
      A string that identifies the next page of stacks that you want to retrieve.
- Class com.amazonaws.services.cloudformation.model.DescribeStacksResult extends Object implements Serializable
  - Serialized Fields
    - stacks
```
com.amazonaws.internal.SdkInternalList<T> stacks
```
      A list of stack structures.
    - nextToken
```
String nextToken
```
      If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.
- Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - templateBody
```
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.
    - templateURL
```
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.
    - parameters
```
com.amazonaws.internal.SdkInternalList<T> parameters
```
      A list of Parameter structures that specify input parameters.
- Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostResult extends Object implements Serializable
  - Serialized Fields
    - url
```
String url
```
      An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.
- Class com.amazonaws.services.cloudformation.model.ExecuteChangeSetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - changeSetName
```
String changeSetName
```
      The name or ARN of the change set that you want use to update the specified stack.
    - stackName
```
String stackName
```
      If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.
- Class com.amazonaws.services.cloudformation.model.ExecuteChangeSetResult extends Object implements Serializable
- Class com.amazonaws.services.cloudformation.model.GetStackPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or unique stack ID that is associated with the stack whose policy you want to get.
- Class com.amazonaws.services.cloudformation.model.GetStackPolicyResult extends Object implements Serializable
  - Serialized Fields
    - stackPolicyBody
```
String stackPolicyBody
```
      Structure containing the stack policy body. (For more information, go to Prevent Updates to Stack Resources in the AWS CloudFormation User Guide.)
- Class com.amazonaws.services.cloudformation.model.GetTemplateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
      
      Running stacks: You can specify either the stack's name or its unique stack ID.
      
      Deleted stacks: You must specify the unique stack ID.
      
      Default: There is no default value.
- Class com.amazonaws.services.cloudformation.model.GetTemplateResult extends Object implements Serializable
  - Serialized Fields
    - templateBody
```
String templateBody
```
      Structure containing the template body. (For more information, go to Template Anatomy in the AWS CloudFormation User Guide.)
- Class com.amazonaws.services.cloudformation.model.GetTemplateSummaryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - templateBody
```
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.
    - 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.
    - stackName
```
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.
- Class com.amazonaws.services.cloudformation.model.GetTemplateSummaryResult extends Object implements Serializable
  - Serialized Fields
    - parameters
```
com.amazonaws.internal.SdkInternalList<T> parameters
```
      A list of parameter declarations that describe various properties for each parameter.
    - description
```
String description
```
      The value that is defined in the Description property of the template.
    - capabilities
```
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.
    - capabilitiesReason
```
String capabilitiesReason
```
      The list of resources that generated the values in the Capabilities response element.
    - resourceTypes
```
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.
    - version
```
String version
```
      The AWS template format version, which identifies the capabilities of the template.
    - metadata
```
String metadata
```
      The value that is defined for the Metadata property of the template.
- Class com.amazonaws.services.cloudformation.model.InsufficientCapabilitiesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudformation.model.InvalidChangeSetStatusException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudformation.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudformation.model.ListChangeSetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.
    - nextToken
```
String nextToken
```
      A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.
- Class com.amazonaws.services.cloudformation.model.ListChangeSetsResult extends Object implements Serializable
  - Serialized Fields
    - summaries
```
com.amazonaws.internal.SdkInternalList<T> summaries
```
      A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.
    - nextToken
```
String nextToken
```
      If the output exceeds 1 MB, a string that identifies the next page of change sets. If there is no additional page, this value is null.
- Class com.amazonaws.services.cloudformation.model.ListStackResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:
      
      Running stacks: You can specify either the stack's name or its unique stack ID.
      
      Deleted stacks: You must specify the unique stack ID.
      
      Default: There is no default value.
    - nextToken
```
String nextToken
```
      A string that identifies the next page of stack resources that you want to retrieve.
- Class com.amazonaws.services.cloudformation.model.ListStackResourcesResult extends Object implements Serializable
  - Serialized Fields
    - stackResourceSummaries
```
com.amazonaws.internal.SdkInternalList<T> stackResourceSummaries
```
      A list of StackResourceSummary structures.
    - nextToken
```
String nextToken
```
      If the output exceeds 1 MB, a string that identifies the next page of stack resources. If no additional page exists, this value is null.
- Class com.amazonaws.services.cloudformation.model.ListStacksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      A string that identifies the next page of stacks that you want to retrieve.
    - stackStatusFilters
```
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.
- Class com.amazonaws.services.cloudformation.model.ListStacksResult extends Object implements Serializable
  - Serialized Fields
    - stackSummaries
```
com.amazonaws.internal.SdkInternalList<T> stackSummaries
```
      A list of StackSummary structures containing information about the specified stacks.
    - nextToken
```
String nextToken
```
      If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.
- Class com.amazonaws.services.cloudformation.model.Output extends Object implements Serializable
  - Serialized Fields
    - outputKey
```
String outputKey
```
      The key associated with the output.
    - outputValue
```
String outputValue
```
      The value associated with the output.
    - description
```
String description
```
      User defined description associated with the output.
- Class com.amazonaws.services.cloudformation.model.Parameter extends Object implements Serializable
  - Serialized Fields
    - parameterKey
```
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.
    - parameterValue
```
String parameterValue
```
      The value associated with the parameter.
    - usePreviousValue
```
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.
- Class com.amazonaws.services.cloudformation.model.ParameterConstraints extends Object implements Serializable
  - Serialized Fields
    - allowedValues
```
com.amazonaws.internal.SdkInternalList<T> allowedValues
```
      A list of values that are permitted for a parameter.
- Class com.amazonaws.services.cloudformation.model.ParameterDeclaration extends Object implements Serializable
  - Serialized Fields
    - parameterKey
```
String parameterKey
```
      The name that is associated with the parameter.
    - defaultValue
```
String defaultValue
```
      The default value of the parameter.
    - parameterType
```
String parameterType
```
      The type of parameter.
    - noEcho
```
Boolean noEcho
```
      Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.
    - description
```
String description
```
      The description that is associate with the parameter.
    - parameterConstraints
```
ParameterConstraints parameterConstraints
```
      The criteria that AWS CloudFormation uses to validate parameter values.
- Class com.amazonaws.services.cloudformation.model.ResourceChange extends Object implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that AWS CloudFormation takes on the resource, such as Add (adds a new resource), Modify (changes a resource), or Remove (deletes a resource).
    - logicalResourceId
```
String logicalResourceId
```
      The resource's logical ID, which is defined in the stack's template.
    - physicalResourceId
```
String physicalResourceId
```
      The resource's physical ID (resource name). Resources that you are adding don't have physical IDs because they haven't been created.
    - resourceType
```
String resourceType
```
      The type of AWS CloudFormation resource, such as AWS::S3::Bucket.
    - replacement
```
String replacement
```
      For the Modify action, indicates whether AWS CloudFormation will replace the resource by creating a new one and deleting the old one. This value depends on the value of the RequiresRecreation property in the ResourceTargetDefinition structure. For example, if the RequiresRecreation field is Always and the Evaluation field is Static, Replacement is True. If the RequiresRecreation field is Always and the Evaluation field is Dynamic, Replacement is Conditionally.
      
      If you have multiple changes with different RequiresRecreation values, the Replacement value depends on the change with the most impact. A RequiresRecreation value of Always has the most impact, followed by Conditionally, and then Never.
    - scope
```
com.amazonaws.internal.SdkInternalList<T> scope
```
      For the Modify action, indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
    - details
```
com.amazonaws.internal.SdkInternalList<T> details
```
      For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the resource.
- Class com.amazonaws.services.cloudformation.model.ResourceChangeDetail extends Object implements Serializable
  - Serialized Fields
    - target
```
ResourceTargetDefinition target
```
      A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.
    - evaluation
```
String evaluation
```
      Indicates whether AWS CloudFormation can determine the target value, and whether the target value will change before you execute a change set.
      
      For Static evaluations, AWS CloudFormation can determine that the target value will change, and its value. For example, if you directly modify the InstanceType property of an EC2 instance, AWS CloudFormation knows that this property value will change, and its value, so this is a Static evaluation.
      
      For Dynamic evaluations, cannot determine the target value because it depends on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic function, when the stack is updated. For example, if your template includes a reference to a resource that is conditionally recreated, the value of the reference (the physical ID of the resource) might change, depending on if the resource is recreated. If the resource is recreated, it will have a new physical ID, so all references to that resource will also be updated.
    - changeSource
```
String changeSource
```
      The group to which the CausingEntity value belongs. There are five entity groups:
      
      ResourceReference entities are Ref intrinsic functions that refer to resources in the template, such as { "Ref" : "MyEC2InstanceResource" }.
      
      ParameterReference entities are Ref intrinsic functions that get template parameter values, such as { "Ref" : "MyPasswordParameter" }.
      
      ResourceAttribute entities are Fn::GetAtt intrinsic functions that get resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", "PublicDnsName" ] } .
      
      DirectModification entities are changes that are made directly to the template.
      
      Automatic entities are AWS::CloudFormation::Stack resource types, which are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack resource, AWS CloudFormation sets the ChangeSource to Automatic because the nested stack's template might have changed. Changes to a nested stack's template aren't visible to AWS CloudFormation until you run an update on the parent stack.
    - causingEntity
```
String causingEntity
```
      The identity of the entity that triggered this change. This entity is a member of the group that is specified by the ChangeSource field. For example, if you modified the value of the KeyPairName parameter, the CausingEntity is the name of the parameter (KeyPairName).
      
      If the ChangeSource value is DirectModification , no value is given for CausingEntity.
- Class com.amazonaws.services.cloudformation.model.ResourceTargetDefinition extends Object implements Serializable
  - Serialized Fields
    - attribute
```
String attribute
```
      Indicates which resource attribute is triggering this update, such as a change in the resource attribute's Metadata, Properties, or Tags.
    - name
```
String name
```
      If the Attribute value is Properties, the name of the property. For all other attributes, the value is null.
    - requiresRecreation
```
String requiresRecreation
```
      If the Attribute value is Properties, indicates whether a change to this property causes the resource to be recreated. The value can be Never, Always, or Conditionally. To determine the conditions for a Conditionally recreation, see the update behavior for that property in the AWS CloudFormation User Guide.
- Class com.amazonaws.services.cloudformation.model.SetStackPolicyRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or unique stack ID that you want to associate a policy with.
    - stackPolicyBody
```
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.
    - stackPolicyURL
```
String stackPolicyURL
```
      Location of a file containing the stack policy. The URL must point to a policy (maximum size: 16 KB) 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.
- Class com.amazonaws.services.cloudformation.model.SignalResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The stack name or unique stack ID that includes the resource that you want to signal.
    - logicalResourceId
```
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.
    - uniqueId
```
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.
    - status
```
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.
- Class com.amazonaws.services.cloudformation.model.Stack extends Object implements Serializable
  - Serialized Fields
    - stackId
```
String stackId
```
      Unique identifier of the stack.
    - stackName
```
String stackName
```
      The name associated with the stack.
    - description
```
String description
```
      A user-defined description associated with the stack.
    - parameters
```
com.amazonaws.internal.SdkInternalList<T> parameters
```
      A list of Parameter structures.
    - creationTime
```
Date creationTime
```
      The time at which the stack was created.
    - lastUpdatedTime
```
Date lastUpdatedTime
```
      The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
    - stackStatus
```
String stackStatus
```
      Current status of the stack.
    - stackStatusReason
```
String stackStatusReason
```
      Success/failure message associated with the stack status.
    - disableRollback
```
Boolean disableRollback
```
      Boolean to enable or disable rollback on stack creation failures:
      
      true: disable rollback
      
      false: enable rollback
    - notificationARNs
```
com.amazonaws.internal.SdkInternalList<T> notificationARNs
```
      SNS topic ARNs to which stack related events are published.
    - timeoutInMinutes
```
Integer timeoutInMinutes
```
      The amount of time within which stack creation should complete.
    - capabilities
```
com.amazonaws.internal.SdkInternalList<T> capabilities
```
      The capabilities allowed in the stack.
    - outputs
```
com.amazonaws.internal.SdkInternalList<T> outputs
```
      A list of output structures.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      A list of Tags that specify information about the stack.
- Class com.amazonaws.services.cloudformation.model.StackEvent extends Object implements Serializable
  - Serialized Fields
    - stackId
```
String stackId
```
      The unique ID name of the instance of the stack.
    - eventId
```
String eventId
```
      The unique ID of this event.
    - stackName
```
String stackName
```
      The name associated with a stack.
    - logicalResourceId
```
String logicalResourceId
```
      The logical name of the resource specified in the template.
    - physicalResourceId
```
String physicalResourceId
```
      The name or unique identifier associated with the physical instance of the resource.
    - resourceType
```
String resourceType
```
      Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
    - timestamp
```
Date timestamp
```
      Time the status was updated.
    - resourceStatus
```
String resourceStatus
```
      Current status of the resource.
    - resourceStatusReason
```
String resourceStatusReason
```
      Success/failure message associated with the resource.
    - resourceProperties
```
String resourceProperties
```
      BLOB of the properties used to create the resource.
- Class com.amazonaws.services.cloudformation.model.StackResource extends Object implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name associated with the stack.
    - stackId
```
String stackId
```
      Unique identifier of the stack.
    - logicalResourceId
```
String logicalResourceId
```
      The logical name of the resource specified in the template.
    - physicalResourceId
```
String physicalResourceId
```
      The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
    - resourceType
```
String resourceType
```
      Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
    - timestamp
```
Date timestamp
```
      Time the status was updated.
    - resourceStatus
```
String resourceStatus
```
      Current status of the resource.
    - resourceStatusReason
```
String resourceStatusReason
```
      Success/failure message associated with the resource.
    - description
```
String description
```
      User defined description associated with the resource.
- Class com.amazonaws.services.cloudformation.model.StackResourceDetail extends Object implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name associated with the stack.
    - stackId
```
String stackId
```
      Unique identifier of the stack.
    - logicalResourceId
```
String logicalResourceId
```
      The logical name of the resource specified in the template.
    - physicalResourceId
```
String physicalResourceId
```
      The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.
    - resourceType
```
String resourceType
```
      Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
    - lastUpdatedTimestamp
```
Date lastUpdatedTimestamp
```
      Time the status was updated.
    - resourceStatus
```
String resourceStatus
```
      Current status of the resource.
    - resourceStatusReason
```
String resourceStatusReason
```
      Success/failure message associated with the resource.
    - description
```
String description
```
      User defined description associated with the resource.
    - metadata
```
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.
- Class com.amazonaws.services.cloudformation.model.StackResourceSummary extends Object implements Serializable
  - Serialized Fields
    - logicalResourceId
```
String logicalResourceId
```
      The logical name of the resource specified in the template.
    - physicalResourceId
```
String physicalResourceId
```
      The name or unique identifier that corresponds to a physical instance ID of the resource.
    - resourceType
```
String resourceType
```
      Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)
    - lastUpdatedTimestamp
```
Date lastUpdatedTimestamp
```
      Time the status was updated.
    - resourceStatus
```
String resourceStatus
```
      Current status of the resource.
    - resourceStatusReason
```
String resourceStatusReason
```
      Success/failure message associated with the resource.
- Class com.amazonaws.services.cloudformation.model.StackSummary extends Object implements Serializable
  - Serialized Fields
    - stackId
```
String stackId
```
      Unique stack identifier.
    - stackName
```
String stackName
```
      The name associated with the stack.
    - templateDescription
```
String templateDescription
```
      The template description of the template used to create the stack.
    - creationTime
```
Date creationTime
```
      The time the stack was created.
    - lastUpdatedTime
```
Date lastUpdatedTime
```
      The time the stack was last updated. This field will only be returned if the stack has been updated at least once.
    - deletionTime
```
Date deletionTime
```
      The time the stack was deleted.
    - stackStatus
```
String stackStatus
```
      The current status of the stack.
    - stackStatusReason
```
String stackStatusReason
```
      Success/Failure message associated with the stack status.
- Class com.amazonaws.services.cloudformation.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
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:.
    - value
```
String value
```
      Required. A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.
- Class com.amazonaws.services.cloudformation.model.TemplateParameter extends Object implements Serializable
  - Serialized Fields
    - parameterKey
```
String parameterKey
```
      The name associated with the parameter.
    - defaultValue
```
String defaultValue
```
      The default value associated with the parameter.
    - noEcho
```
Boolean noEcho
```
      Flag indicating whether the parameter should be displayed as plain text in logs and UIs.
    - description
```
String description
```
      User defined description associated with the parameter.
- Class com.amazonaws.services.cloudformation.model.UpdateStackRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - stackName
```
String stackName
```
      The name or unique stack ID of the stack to update.
    - templateBody
```
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.
    - templateURL
```
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.
    - usePreviousTemplate
```
Boolean usePreviousTemplate
```
      Reuse the existing template that is associated with the stack that you are updating.
    - stackPolicyDuringUpdateBody
```
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.
    - stackPolicyDuringUpdateURL
```
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.
    - parameters
```
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.
    - capabilities
```
com.amazonaws.internal.SdkInternalList<T> capabilities
```
      A list of capabilities that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. 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 all permissions associated with them and edit their permissions if necessary. If your template contains any of the listed resources and you don't specify this parameter, this action returns an InsufficientCapabilities error.
    - resourceTypes
```
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.
    - stackPolicyBody
```
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.
    - stackPolicyURL
```
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.
    - notificationARNs
```
com.amazonaws.internal.SdkInternalList<T> notificationARNs
```
      Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that AWS CloudFormation associates with the stack. Specify an empty list to remove all notification topics.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.
      
      If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
- Class com.amazonaws.services.cloudformation.model.UpdateStackResult extends Object implements Serializable
  - Serialized Fields
    - stackId
```
String stackId
```
      Unique identifier of the stack.
- Class com.amazonaws.services.cloudformation.model.ValidateTemplateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - templateBody
```
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.
    - 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, 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.
- Class com.amazonaws.services.cloudformation.model.ValidateTemplateResult extends Object implements Serializable
  - Serialized Fields
    - parameters
```
com.amazonaws.internal.SdkInternalList<T> parameters
```
      A list of TemplateParameter structures.
    - description
```
String description
```
      The description found within the template.
    - capabilities
```
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.
    - capabilitiesReason
```
String capabilitiesReason
```
      The list of resources that generated the values in the Capabilities response element.
Package com.amazonaws.services.cloudfront_2012_03_15.model
- Class com.amazonaws.services.cloudfront_2012_03_15.model.AccessDeniedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.BatchTooLargeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.CloudFrontOriginAccessIdentityAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.CloudFrontOriginAccessIdentityInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.CNAMEAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.DistributionAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.DistributionNotDisabledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.IllegalUpdateException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidArgumentException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidDefaultRootObjectException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidIfMatchVersionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidOriginAccessIdentityException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidOriginException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.InvalidRequiredProtocolException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.MissingBodyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchCloudFrontOriginAccessIdentityException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchDistributionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchInvalidationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.NoSuchStreamingDistributionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.PreconditionFailedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.StreamingDistributionAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.StreamingDistributionNotDisabledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyCloudFrontOriginAccessIdentitiesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyDistributionCNAMEsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyDistributionsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyInvalidationsInProgressException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyStreamingDistributionCNAMEsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyStreamingDistributionsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TooManyTrustedSignersException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront_2012_03_15.model.TrustedSignerDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.cloudfront.model
- Class com.amazonaws.services.cloudfront.model.AccessDeniedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.ActiveTrustedSigners extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Each active trusted signer.
    - quantity
```
Integer quantity
```
      The number of unique trusted signers included in all cache behaviors. For example, if three cache behaviors all list the same three AWS accounts, the value of Quantity for ActiveTrustedSigners will be 3.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains one Signer complex type for each unique trusted signer that is specified in the TrustedSigners complex type, including trusted signers in the default cache behavior and in all of the other cache behaviors.
- Class com.amazonaws.services.cloudfront.model.Aliases extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of CNAMEs, if any, for this distribution.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.
- Class com.amazonaws.services.cloudfront.model.AllowedMethods extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for GET and HEAD requests), 3 (for GET, HEAD and OPTIONS requests) and 7 (for GET, HEAD, OPTIONS, PUT, PATCH, POST, and DELETE requests).
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.
    - cachedMethods
```
CachedMethods cachedMethods
```
- Class com.amazonaws.services.cloudfront.model.BatchTooLargeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.CacheBehavior extends Object implements Serializable
  - Serialized Fields
    - pathPattern
```
String pathPattern
```
      The pattern (for example, images/*.jpg) that specifies which requests you want this cache behavior to apply to. When CloudFront receives an end-user request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. The path pattern for the default cache behavior is * and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.
    - targetOriginId
```
String targetOriginId
```
      The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.
    - forwardedValues
```
ForwardedValues forwardedValues
```
      A complex type that specifies how CloudFront handles query strings, cookies and headers.
    - trustedSigners
```
TrustedSigners trustedSigners
```
      A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
    - viewerProtocolPolicy
```
String viewerProtocolPolicy
```
      Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL.
    - minTTL
```
Long minTTL
```
      The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).
    - allowedMethods
```
AllowedMethods allowedMethods
```
    - smoothStreaming
```
Boolean smoothStreaming
```
      Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false.
    - defaultTTL
```
Long defaultTTL
```
      If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
    - maxTTL
```
Long maxTTL
```
      The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
    - compress
```
Boolean compress
```
      Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version.
- Class com.amazonaws.services.cloudfront.model.CacheBehaviors extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of cache behaviors for this distribution.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.
- Class com.amazonaws.services.cloudfront.model.CachedMethods extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of HTTP methods for which you want CloudFront to cache responses. Valid values are 2 (for caching responses to GET and HEAD requests) and 3 (for caching responses to GET, HEAD, and OPTIONS requests).
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains the HTTP methods that you want CloudFront to cache responses to.
- Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentity extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID for the origin access identity. For example: E74FTE3AJFJ256A.
    - s3CanonicalUserId
```
String s3CanonicalUserId
```
      The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.
    - cloudFrontOriginAccessIdentityConfig
```
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
```
      The current configuration information for the identity.
- Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityConfig extends Object implements Serializable
  - Serialized Fields
    - callerReference
```
String callerReference
```
      A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the CloudFrontOriginAccessIdentityConfig object), a new origin access identity is created. If the CallerReference is a value you already sent in a previous request to create an identity, and the content of the CloudFrontOriginAccessIdentityConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create an identity but the content of the CloudFrontOriginAccessIdentityConfig is different from the original request, CloudFront returns a CloudFrontOriginAccessIdentityAlreadyExists error.
    - comment
```
String comment
```
      Any comments you want to include about the origin access identity.
- Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityList extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      The value you provided for the Marker request parameter.
    - nextMarker
```
String nextMarker
```
      If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your origin access identities where they left off.
    - maxItems
```
Integer maxItems
```
      The value you provided for the MaxItems request parameter.
    - isTruncated
```
Boolean isTruncated
```
      A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more items in the list.
    - quantity
```
Integer quantity
```
      The number of CloudFront origin access identities that were created by the current AWS account.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.
- Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentitySummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID for the origin access identity. For example: E74FTE3AJFJ256A.
    - s3CanonicalUserId
```
String s3CanonicalUserId
```
      The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.
    - comment
```
String comment
```
      The comment for this origin access identity, as originally specified when created.
- Class com.amazonaws.services.cloudfront.model.CNAMEAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.CookieNames extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of whitelisted cookies for this cache behavior.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items.
- Class com.amazonaws.services.cloudfront.model.CookiePreference extends Object implements Serializable
  - Serialized Fields
    - forward
```
String forward
```
      Use this element to specify whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify all, none or whitelist. If you choose All, CloudFront forwards all cookies regardless of how many your application uses.
    - whitelistedNames
```
CookieNames whitelistedNames
```
      A complex type that specifies the whitelisted cookies, if any, that you want CloudFront to forward to your origin that is associated with this cache behavior.
- Class com.amazonaws.services.cloudfront.model.CreateCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - cloudFrontOriginAccessIdentityConfig
```
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
```
      The origin access identity's configuration information.
- Class com.amazonaws.services.cloudfront.model.CreateCloudFrontOriginAccessIdentityResult extends Object implements Serializable
  - Serialized Fields
    - cloudFrontOriginAccessIdentity
```
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
```
      The origin access identity's information.
    - location
```
String location
```
      The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity /cloudfront/E74FTE3AJFJ256A.
    - eTag
```
String eTag
```
      The current version of the origin access identity created.
- Class com.amazonaws.services.cloudfront.model.CreateDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - distributionConfig
```
DistributionConfig distributionConfig
```
      The distribution's configuration information.
- Class com.amazonaws.services.cloudfront.model.CreateDistributionResult extends Object implements Serializable
  - Serialized Fields
    - distribution
```
Distribution distribution
```
      The distribution's information.
    - location
```
String location
```
      The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.
    - eTag
```
String eTag
```
      The current version of the distribution created.
- Class com.amazonaws.services.cloudfront.model.CreateInvalidationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - distributionId
```
String distributionId
```
      The distribution's id.
    - invalidationBatch
```
InvalidationBatch invalidationBatch
```
      The batch information for the invalidation.
- Class com.amazonaws.services.cloudfront.model.CreateInvalidationResult extends Object implements Serializable
  - Serialized Fields
    - location
```
String location
```
      The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.
    - invalidation
```
Invalidation invalidation
```
      The invalidation's information.
- Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamingDistributionConfig
```
StreamingDistributionConfig streamingDistributionConfig
```
      The streaming distribution's configuration information.
- Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionResult extends Object implements Serializable
  - Serialized Fields
    - streamingDistribution
```
StreamingDistribution streamingDistribution
```
      The streaming distribution's information.
    - location
```
String location
```
      The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming -distribution/EGTXBD79H29TRA8.
    - eTag
```
String eTag
```
      The current version of the streaming distribution created.
- Class com.amazonaws.services.cloudfront.model.CustomErrorResponse extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
Integer errorCode
```
      The 4xx or 5xx HTTP status code that you want to customize. For a list of HTTP status codes that you can customize, see CloudFront documentation.
    - responsePagePath
```
String responsePagePath
```
      The path of the custom error page (for example, /custom_404.html). The path is relative to the distribution and must begin with a slash (/). If the path includes any non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not return the custom error page to the viewer.
    - responseCode
```
String responseCode
```
      The HTTP status code that you want CloudFront to return with the custom error page to the viewer. For a list of HTTP status codes that you can replace, see CloudFront Documentation.
    - errorCachingMinTTL
```
Long errorCachingMinTTL
```
      The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. You can specify a value from 0 to 31,536,000.
- Class com.amazonaws.services.cloudfront.model.CustomErrorResponses extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of custom error responses for this distribution.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items.
- Class com.amazonaws.services.cloudfront.model.CustomHeaders extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of custom headers for this origin.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains the custom headers for this Origin.
- Class com.amazonaws.services.cloudfront.model.CustomOriginConfig extends Object implements Serializable
  - Serialized Fields
    - hTTPPort
```
Integer hTTPPort
```
      The HTTP port the custom origin listens on.
    - hTTPSPort
```
Integer hTTPSPort
```
      The HTTPS port the custom origin listens on.
    - originProtocolPolicy
```
String originProtocolPolicy
```
      The origin protocol policy to apply to your origin.
    - originSslProtocols
```
OriginSslProtocols originSslProtocols
```
      The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.
- Class com.amazonaws.services.cloudfront.model.DefaultCacheBehavior extends Object implements Serializable
  - Serialized Fields
    - targetOriginId
```
String targetOriginId
```
      The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.
    - forwardedValues
```
ForwardedValues forwardedValues
```
      A complex type that specifies how CloudFront handles query strings, cookies and headers.
    - trustedSigners
```
TrustedSigners trustedSigners
```
      A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
    - viewerProtocolPolicy
```
String viewerProtocolPolicy
```
      Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. If you want CloudFront to allow end users to use any available protocol, specify allow-all. If you want CloudFront to require HTTPS, specify https. If you want CloudFront to respond to an HTTP request with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL, specify redirect-to-https. The viewer then resubmits the request using the HTTPS URL.
    - minTTL
```
Long minTTL
```
      The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated.You can specify a value from 0 to 3,153,600,000 seconds (100 years).
    - allowedMethods
```
AllowedMethods allowedMethods
```
    - smoothStreaming
```
Boolean smoothStreaming
```
      Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify true; if not, specify false.
    - defaultTTL
```
Long defaultTTL
```
      If you don't configure your origin to add a Cache-Control max-age directive or an Expires header, DefaultTTL is the default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
    - maxTTL
```
Long maxTTL
```
      The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as Cache-Control max-age, Cache-Control s-maxage, and Expires to objects. You can specify a value from 0 to 3,153,600,000 seconds (100 years).
    - compress
```
Boolean compress
```
      Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header. If so, specify true; if not, specify false. CloudFront compresses files larger than 1000 bytes and less than 1 megabyte for both Amazon S3 and custom origins. When a CloudFront edge location is unusually busy, some files might not be compressed. The value of the Content-Type header must be on the list of file types that CloudFront will compress. For the current list, see Serving Compressed Content in the Amazon CloudFront Developer Guide. If you configure CloudFront to compress content, CloudFront removes the ETag response header from the objects that it compresses. The ETag header indicates that the version in a CloudFront edge cache is identical to the version on the origin server, but after compression the two versions are no longer identical. As a result, for compressed objects, CloudFront can't use the ETag header to determine whether an expired object in the CloudFront edge cache is still the latest version.
- Class com.amazonaws.services.cloudfront.model.DeleteCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The origin access identity's id.
    - ifMatch
```
String ifMatch
```
      The value of the ETag header you received from a previous GET or PUT request. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.DeleteDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The distribution id.
    - ifMatch
```
String ifMatch
```
      The value of the ETag header you received when you disabled the distribution. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.DeleteStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The distribution id.
    - ifMatch
```
String ifMatch
```
      The value of the ETag header you received when you disabled the streaming distribution. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.Distribution extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the distribution. For example: EDFDVBD632BHDS5.
    - status
```
String status
```
      This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time the distribution was last modified.
    - inProgressInvalidationBatches
```
Integer inProgressInvalidationBatches
```
      The number of invalidation batches currently in progress.
    - domainName
```
String domainName
```
      The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.
    - activeTrustedSigners
```
ActiveTrustedSigners activeTrustedSigners
```
      CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.
    - distributionConfig
```
DistributionConfig distributionConfig
```
      The current configuration information for the distribution.
- Class com.amazonaws.services.cloudfront.model.DistributionAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.DistributionConfig extends Object implements Serializable
  - Serialized Fields
    - callerReference
```
String callerReference
```
      A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the DistributionConfig object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create a distribution, and the content of the DistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of the DistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.
    - aliases
```
Aliases aliases
```
      A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
    - defaultRootObject
```
String defaultRootObject
```
      The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL for your distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/index.html). Specifying a default root object avoids exposing the contents of your distribution. If you don't want to specify a default root object when you create a distribution, include an empty DefaultRootObject element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty DefaultRootObject element. To replace the default root object, update the distribution configuration and specify the new object.
    - origins
```
Origins origins
```
      A complex type that contains information about origins for this distribution.
    - defaultCacheBehavior
```
DefaultCacheBehavior defaultCacheBehavior
```
      A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.
    - cacheBehaviors
```
CacheBehaviors cacheBehaviors
```
      A complex type that contains zero or more CacheBehavior elements.
    - customErrorResponses
```
CustomErrorResponses customErrorResponses
```
      A complex type that contains zero or more CustomErrorResponse elements.
    - comment
```
String comment
```
      Any comments you want to include about the distribution.
    - logging
```
LoggingConfig logging
```
      A complex type that controls whether access logs are written for the distribution.
    - priceClass
```
String priceClass
```
      A complex type that contains information about price class for this distribution.
    - enabled
```
Boolean enabled
```
      Whether the distribution is enabled to accept end user requests for content.
    - viewerCertificate
```
ViewerCertificate viewerCertificate
```
    - restrictions
```
Restrictions restrictions
```
    - webACLId
```
String webACLId
```
      (Optional) If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution.
- Class com.amazonaws.services.cloudfront.model.DistributionList extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      The value you provided for the Marker request parameter.
    - nextMarker
```
String nextMarker
```
      If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your distributions where they left off.
    - maxItems
```
Integer maxItems
```
      The value you provided for the MaxItems request parameter.
    - isTruncated
```
Boolean isTruncated
```
      A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
    - quantity
```
Integer quantity
```
      The number of distributions that were created by the current AWS account.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.
- Class com.amazonaws.services.cloudfront.model.DistributionNotDisabledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.DistributionSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the distribution. For example: EDFDVBD632BHDS5.
    - status
```
String status
```
      This response element indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time the distribution was last modified.
    - domainName
```
String domainName
```
      The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.
    - aliases
```
Aliases aliases
```
      A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.
    - origins
```
Origins origins
```
      A complex type that contains information about origins for this distribution.
    - defaultCacheBehavior
```
DefaultCacheBehavior defaultCacheBehavior
```
      A complex type that describes the default cache behavior if you do not specify a CacheBehavior element or if files don't match any of the values of PathPattern in CacheBehavior elements.You must create exactly one default cache behavior.
    - cacheBehaviors
```
CacheBehaviors cacheBehaviors
```
      A complex type that contains zero or more CacheBehavior elements.
    - customErrorResponses
```
CustomErrorResponses customErrorResponses
```
      A complex type that contains zero or more CustomErrorResponses elements.
    - comment
```
String comment
```
      The comment originally specified when this distribution was created.
    - priceClass
```
String priceClass
```
    - enabled
```
Boolean enabled
```
      Whether the distribution is enabled to accept end user requests for content.
    - viewerCertificate
```
ViewerCertificate viewerCertificate
```
    - restrictions
```
Restrictions restrictions
```
    - webACLId
```
String webACLId
```
      The Web ACL Id (if any) associated with the distribution.
- Class com.amazonaws.services.cloudfront.model.ForwardedValues extends Object implements Serializable
  - Serialized Fields
    - queryString
```
Boolean queryString
```
      Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. If so, specify true; if not, specify false.
    - cookies
```
CookiePreference cookies
```
      A complex type that specifies how CloudFront handles cookies.
    - headers
```
Headers headers
```
      A complex type that specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior.
- Class com.amazonaws.services.cloudfront.model.GeoRestriction extends Object implements Serializable
  - Serialized Fields
    - restrictionType
```
String restrictionType
```
      The method that you want to use to restrict distribution of your content by country: - none: No geo restriction is enabled, meaning access to content is not restricted by client geo location. - blacklist: The Location elements specify the countries in which you do not want CloudFront to distribute your content. - whitelist: The Location elements specify the countries in which you want CloudFront to distribute your content.
    - quantity
```
Integer quantity
```
      When geo restriction is enabled, this is the number of countries in your whitelist or blacklist. Otherwise, when it is not enabled, Quantity is 0, and you can omit Items.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains a Location element for each country in which you want CloudFront either to distribute your content (whitelist) or not distribute your content (blacklist). The Location element is a two-letter, uppercase country code for a country that you want to include in your blacklist or whitelist. Include one Location element for each country. CloudFront and MaxMind both use ISO 3166 country codes. For the current list of countries and the corresponding codes, see ISO 3166-1-alpha-2 code on the International Organization for Standardization website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.
- Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identity's id.
- Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigResult extends Object implements Serializable
  - Serialized Fields
    - cloudFrontOriginAccessIdentityConfig
```
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
```
      The origin access identity's configuration information.
    - eTag
```
String eTag
```
      The current version of the configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identity's id.
- Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityResult extends Object implements Serializable
  - Serialized Fields
    - cloudFrontOriginAccessIdentity
```
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
```
      The origin access identity's information.
    - eTag
```
String eTag
```
      The current version of the origin access identity's information. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.GetDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The distribution's id.
- Class com.amazonaws.services.cloudfront.model.GetDistributionConfigResult extends Object implements Serializable
  - Serialized Fields
    - distributionConfig
```
DistributionConfig distributionConfig
```
      The distribution's configuration information.
    - eTag
```
String eTag
```
      The current version of the configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.GetDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The distribution's id.
- Class com.amazonaws.services.cloudfront.model.GetDistributionResult extends Object implements Serializable
  - Serialized Fields
    - distribution
```
Distribution distribution
```
      The distribution's information.
    - eTag
```
String eTag
```
      The current version of the distribution's information. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.GetInvalidationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - distributionId
```
String distributionId
```
      The distribution's id.
    - id
```
String id
```
      The invalidation's id.
- Class com.amazonaws.services.cloudfront.model.GetInvalidationResult extends Object implements Serializable
  - Serialized Fields
    - invalidation
```
Invalidation invalidation
```
      The invalidation's information.
- Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The streaming distribution's id.
- Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigResult extends Object implements Serializable
  - Serialized Fields
    - streamingDistributionConfig
```
StreamingDistributionConfig streamingDistributionConfig
```
      The streaming distribution's configuration information.
    - eTag
```
String eTag
```
      The current version of the configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The streaming distribution's id.
- Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionResult extends Object implements Serializable
  - Serialized Fields
    - streamingDistribution
```
StreamingDistribution streamingDistribution
```
      The streaming distribution's information.
    - eTag
```
String eTag
```
      The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.Headers extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of different headers that you want CloudFront to forward to the origin and to vary on for this cache behavior. The maximum number of headers that you can specify by name is 10. If you want CloudFront to forward all headers to the origin and vary on all of them, specify 1 for Quantity and * for Name. If you don't want CloudFront to forward any additional headers to the origin or to vary on any headers, specify 0 for Quantity and omit Items.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      Optional: A complex type that contains a Name element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If Quantity is 0, omit Items.
- Class com.amazonaws.services.cloudfront.model.IllegalUpdateException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InconsistentQuantitiesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidArgumentException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.Invalidation extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the invalidation request. For example: IDFDVBD632BHDS5.
    - status
```
String status
```
      The status of the invalidation request. When the invalidation batch is finished, the status is Completed.
    - createTime
```
Date createTime
```
      The date and time the invalidation request was first made.
    - invalidationBatch
```
InvalidationBatch invalidationBatch
```
      The current invalidation information for the batch request.
- Class com.amazonaws.services.cloudfront.model.InvalidationBatch extends Object implements Serializable
  - Serialized Fields
    - paths
```
Paths paths
```
      The path of the object to invalidate. The path is relative to the distribution and must begin with a slash (/). You must enclose each invalidation object with the Path element tags. If the path includes non-ASCII characters or unsafe characters as defined in RFC 1783 (http://www.ietf.org/rfc/rfc1738.txt), URL encode those characters. Do not URL encode any other characters in the path, or CloudFront will not invalidate the old version of the updated object.
    - callerReference
```
String callerReference
```
      A unique name that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the Path object), a new distribution is created. If the CallerReference is a value you already sent in a previous request to create an invalidation batch, and the content of each Path element is identical to the original request, the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a distribution but the content of any Path is different from the original request, CloudFront returns an InvalidationBatchAlreadyExists error.
- Class com.amazonaws.services.cloudfront.model.InvalidationList extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      The value you provided for the Marker request parameter.
    - nextMarker
```
String nextMarker
```
      If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your invalidation batches where they left off.
    - maxItems
```
Integer maxItems
```
      The value you provided for the MaxItems request parameter.
    - isTruncated
```
Boolean isTruncated
```
      A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more invalidation batches in the list.
    - quantity
```
Integer quantity
```
      The number of invalidation batches that were created by the current AWS account.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account.
- Class com.amazonaws.services.cloudfront.model.InvalidationSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique ID for an invalidation request.
    - createTime
```
Date createTime
```
    - status
```
String status
```
      The status of an invalidation request.
- Class com.amazonaws.services.cloudfront.model.InvalidDefaultRootObjectException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidErrorCodeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidForwardCookiesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidGeoRestrictionParameterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidHeadersForS3OriginException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidIfMatchVersionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidLocationCodeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidMinimumProtocolVersionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidOriginAccessIdentityException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidOriginException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidProtocolSettingsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidRelativePathException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidRequiredProtocolException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidResponseCodeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidTTLOrderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidViewerCertificateException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.InvalidWebACLIdException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.KeyPairIds extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of active CloudFront key pairs for AwsAccountNumber.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.
- Class com.amazonaws.services.cloudfront.model.ListCloudFrontOriginAccessIdentitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last identity on that page).
    - maxItems
```
String maxItems
```
      The maximum number of origin access identities you want in the response body.
- Class com.amazonaws.services.cloudfront.model.ListCloudFrontOriginAccessIdentitiesResult extends Object implements Serializable
  - Serialized Fields
    - cloudFrontOriginAccessIdentityList
```
CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList
```
      The CloudFrontOriginAccessIdentityList type.
- Class com.amazonaws.services.cloudfront.model.ListDistributionsByWebACLIdRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)
    - maxItems
```
String maxItems
```
      The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
    - webACLId
```
String webACLId
```
      The Id of the AWS WAF web ACL for which you want to list the associated distributions. If you specify "null" for the Id, the request returns a list of the distributions that aren't associated with a web ACL.
- Class com.amazonaws.services.cloudfront.model.ListDistributionsByWebACLIdResult extends Object implements Serializable
  - Serialized Fields
    - distributionList
```
DistributionList distributionList
```
      The DistributionList type.
- Class com.amazonaws.services.cloudfront.model.ListDistributionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      Use Marker and MaxItems to control pagination of results. If you have more than MaxItems distributions that satisfy the request, the response includes a NextMarker element. To get the next page of results, submit another request. For the value of Marker, specify the value of NextMarker from the last response. (For the first request, omit Marker.)
    - maxItems
```
String maxItems
```
      The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
- Class com.amazonaws.services.cloudfront.model.ListDistributionsResult extends Object implements Serializable
  - Serialized Fields
    - distributionList
```
DistributionList distributionList
```
      The DistributionList type.
- Class com.amazonaws.services.cloudfront.model.ListInvalidationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - distributionId
```
String distributionId
```
      The distribution's id.
    - marker
```
String marker
```
      Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response. This value is the same as the ID of the last invalidation batch on that page.
    - maxItems
```
String maxItems
```
      The maximum number of invalidation batches you want in the response body.
- Class com.amazonaws.services.cloudfront.model.ListInvalidationsResult extends Object implements Serializable
  - Serialized Fields
    - invalidationList
```
InvalidationList invalidationList
```
      Information about invalidation batches.
- Class com.amazonaws.services.cloudfront.model.ListStreamingDistributionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      Use this when paginating results to indicate where to begin in your list of streaming distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the Marker to the value of the NextMarker from the current page's response (which is also the ID of the last distribution on that page).
    - maxItems
```
String maxItems
```
      The maximum number of streaming distributions you want in the response body.
- Class com.amazonaws.services.cloudfront.model.ListStreamingDistributionsResult extends Object implements Serializable
  - Serialized Fields
    - streamingDistributionList
```
StreamingDistributionList streamingDistributionList
```
      The StreamingDistributionList type.
- Class com.amazonaws.services.cloudfront.model.LoggingConfig extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix and IncludeCookies, the values are automatically deleted.
    - includeCookies
```
Boolean includeCookies
```
      Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.
    - bucket
```
String bucket
```
      The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
    - prefix
```
String prefix
```
      An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.
- Class com.amazonaws.services.cloudfront.model.MissingBodyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.NoSuchCloudFrontOriginAccessIdentityException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.NoSuchDistributionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.NoSuchInvalidationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.NoSuchOriginException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.NoSuchStreamingDistributionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.Origin extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      A unique identifier for the origin. The value of Id must be unique within the distribution. You use the value of Id when you create a cache behavior. The Id identifies the origin that CloudFront routes a request to when the request matches the path pattern for that cache behavior.
    - domainName
```
String domainName
```
      Amazon S3 origins: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, myawsbucket.s3.amazonaws.com. Custom origins: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, www.example.com.
    - originPath
```
String originPath
```
      An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the OriginPath element, specify the directory name, beginning with a /. CloudFront appends the directory name to the value of DomainName.
    - customHeaders
```
CustomHeaders customHeaders
```
      A complex type that contains information about the custom headers associated with this Origin.
    - s3OriginConfig
```
S3OriginConfig s3OriginConfig
```
      A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the CustomOriginConfig element instead.
    - customOriginConfig
```
CustomOriginConfig customOriginConfig
```
      A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the S3OriginConfig element instead.
- Class com.amazonaws.services.cloudfront.model.OriginCustomHeader extends Object implements Serializable
  - Serialized Fields
    - headerName
```
String headerName
```
      The header's name.
    - headerValue
```
String headerValue
```
      The header's value.
- Class com.amazonaws.services.cloudfront.model.Origins extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of origins for this distribution.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains origins for this distribution.
- Class com.amazonaws.services.cloudfront.model.OriginSslProtocols extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains one SslProtocol element for each SSL/TLS protocol that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
- Class com.amazonaws.services.cloudfront.model.Paths extends Object implements Serializable
  - Serialized Fields
    - quantity
```
Integer quantity
```
      The number of objects that you want to invalidate.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains a list of the objects that you want to invalidate.
- Class com.amazonaws.services.cloudfront.model.PreconditionFailedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.Restrictions extends Object implements Serializable
  - Serialized Fields
    - geoRestriction
```
GeoRestriction geoRestriction
```
- Class com.amazonaws.services.cloudfront.model.S3Origin extends Object implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The DNS name of the S3 origin.
    - originAccessIdentity
```
String originAccessIdentity
```
      Your S3 origin's origin access identity.
- Class com.amazonaws.services.cloudfront.model.S3OriginConfig extends Object implements Serializable
  - Serialized Fields
    - originAccessIdentity
```
String originAccessIdentity
```
      The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that end users can only access objects in an Amazon S3 bucket through CloudFront. If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty OriginAccessIdentity element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty OriginAccessIdentity element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. Use the format origin-access-identity/cloudfront/Id where Id is the value that CloudFront returned in the Id element when you created the origin access identity.
- Class com.amazonaws.services.cloudfront.model.Signer extends Object implements Serializable
  - Serialized Fields
    - awsAccountNumber
```
String awsAccountNumber
```
      Specifies an AWS account that can create signed URLs. Values: self, which indicates that the AWS account that was used to create the distribution can created signed URLs, or an AWS account number. Omit the dashes in the account number.
    - keyPairIds
```
KeyPairIds keyPairIds
```
      A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.
- Class com.amazonaws.services.cloudfront.model.StreamingDistribution extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.
    - status
```
String status
```
      The current status of the streaming distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time the distribution was last modified.
    - domainName
```
String domainName
```
      The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.
    - activeTrustedSigners
```
ActiveTrustedSigners activeTrustedSigners
```
      CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The Signer child element lists the AWS account number of the trusted signer (or an empty Self element if the signer is you). The Signer element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no KeyPairId element appears for a Signer, that signer can't create working signed URLs.
    - streamingDistributionConfig
```
StreamingDistributionConfig streamingDistributionConfig
```
      The current configuration information for the streaming distribution.
- Class com.amazonaws.services.cloudfront.model.StreamingDistributionAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.StreamingDistributionConfig extends Object implements Serializable
  - Serialized Fields
    - callerReference
```
String callerReference
```
      A unique number that ensures the request can't be replayed. If the CallerReference is new (no matter the content of the StreamingDistributionConfig object), a new streaming distribution is created. If the CallerReference is a value you already sent in a previous request to create a streaming distribution, and the content of the StreamingDistributionConfig is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the CallerReference is a value you already sent in a previous request to create a streaming distribution but the content of the StreamingDistributionConfig is different from the original request, CloudFront returns a DistributionAlreadyExists error.
    - s3Origin
```
S3Origin s3Origin
```
      A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
    - aliases
```
Aliases aliases
```
      A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
    - comment
```
String comment
```
      Any comments you want to include about the streaming distribution.
    - logging
```
StreamingLoggingConfig logging
```
      A complex type that controls whether access logs are written for the streaming distribution.
    - trustedSigners
```
TrustedSigners trustedSigners
```
      A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
    - priceClass
```
String priceClass
```
      A complex type that contains information about price class for this streaming distribution.
    - enabled
```
Boolean enabled
```
      Whether the streaming distribution is enabled to accept end user requests for content.
- Class com.amazonaws.services.cloudfront.model.StreamingDistributionList extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      The value you provided for the Marker request parameter.
    - nextMarker
```
String nextMarker
```
      If IsTruncated is true, this element is present and contains the value you can use for the Marker request parameter to continue listing your streaming distributions where they left off.
    - maxItems
```
Integer maxItems
```
      The value you provided for the MaxItems request parameter.
    - isTruncated
```
Boolean isTruncated
```
      A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the Marker request parameter to retrieve more distributions in the list.
    - quantity
```
Integer quantity
```
      The number of streaming distributions that were created by the current AWS account.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.
- Class com.amazonaws.services.cloudfront.model.StreamingDistributionNotDisabledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.StreamingDistributionSummary extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier for the distribution. For example: EDFDVBD632BHDS5.
    - status
```
String status
```
      Indicates the current status of the distribution. When the status is Deployed, the distribution's information is fully propagated throughout the Amazon CloudFront system.
    - lastModifiedTime
```
Date lastModifiedTime
```
      The date and time the distribution was last modified.
    - domainName
```
String domainName
```
      The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.
    - s3Origin
```
S3Origin s3Origin
```
      A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.
    - aliases
```
Aliases aliases
```
      A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.
    - trustedSigners
```
TrustedSigners trustedSigners
```
      A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the PathPattern for this cache behavior, specify true for Enabled, and specify the applicable values for Quantity and Items. For more information, go to Using a Signed URL to Serve Private Content in the Amazon CloudFront Developer Guide. If you don't want to require signed URLs in requests for objects that match PathPattern, specify false for Enabled and 0 for Quantity. Omit Items. To add, change, or remove one or more trusted signers, change Enabled to true (if it's currently false), change Quantity as applicable, and specify all of the trusted signers that you want to include in the updated distribution.
    - comment
```
String comment
```
      The comment originally specified when this distribution was created.
    - priceClass
```
String priceClass
```
    - enabled
```
Boolean enabled
```
      Whether the distribution is enabled to accept end user requests for content.
- Class com.amazonaws.services.cloudfront.model.StreamingLoggingConfig extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket and Prefix, the values are automatically deleted.
    - bucket
```
String bucket
```
      The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.
    - prefix
```
String prefix
```
      An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, myprefix/. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty Prefix element in the Logging element.
- Class com.amazonaws.services.cloudfront.model.TooManyCacheBehaviorsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyCertificatesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyCloudFrontOriginAccessIdentitiesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyCookieNamesInWhiteListException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyDistributionCNAMEsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyDistributionsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyHeadersInForwardedValuesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyInvalidationsInProgressException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyOriginCustomHeadersException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyOriginsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionCNAMEsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TooManyTrustedSignersException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TrustedSignerDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudfront.model.TrustedSigners extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Specifies whether you want to require end users to use signed URLs to access the files specified by PathPattern and TargetOriginId.
    - quantity
```
Integer quantity
```
      The number of trusted signers for this cache behavior.
    - items
```
com.amazonaws.internal.SdkInternalList<T> items
```
      Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.
- Class com.amazonaws.services.cloudfront.model.UpdateCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - cloudFrontOriginAccessIdentityConfig
```
CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig
```
      The identity's configuration information.
    - id
```
String id
```
      The identity's id.
    - ifMatch
```
String ifMatch
```
      The value of the ETag header you received when retrieving the identity's configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.UpdateCloudFrontOriginAccessIdentityResult extends Object implements Serializable
  - Serialized Fields
    - cloudFrontOriginAccessIdentity
```
CloudFrontOriginAccessIdentity cloudFrontOriginAccessIdentity
```
      The origin access identity's information.
    - eTag
```
String eTag
```
      The current version of the configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.UpdateDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - distributionConfig
```
DistributionConfig distributionConfig
```
      The distribution's configuration information.
    - id
```
String id
```
      The distribution's id.
    - ifMatch
```
String ifMatch
```
      The value of the ETag header you received when retrieving the distribution's configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.UpdateDistributionResult extends Object implements Serializable
  - Serialized Fields
    - distribution
```
Distribution distribution
```
      The distribution's information.
    - eTag
```
String eTag
```
      The current version of the configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.UpdateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamingDistributionConfig
```
StreamingDistributionConfig streamingDistributionConfig
```
      The streaming distribution's configuration information.
    - id
```
String id
```
      The streaming distribution's id.
    - ifMatch
```
String ifMatch
```
      The value of the ETag header you received when retrieving the streaming distribution's configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.UpdateStreamingDistributionResult extends Object implements Serializable
  - Serialized Fields
    - streamingDistribution
```
StreamingDistribution streamingDistribution
```
      The streaming distribution's information.
    - eTag
```
String eTag
```
      The current version of the configuration. For example: E2QWRUHAPOMQZL.
- Class com.amazonaws.services.cloudfront.model.ViewerCertificate extends Object implements Serializable
  - Serialized Fields
    - cloudFrontDefaultCertificate
```
Boolean cloudFrontDefaultCertificate
```
      If you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name of your distribution in your object URLs (for example, https://d111111abcdef8.cloudfront.net/logo.jpg), set to true. Omit this value if you are setting an ACMCertificateArn or IAMCertificateId.
    - iAMCertificateId
```
String iAMCertificateId
```
      If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the IAM certificate identifier of the custom viewer certificate for this distribution. Specify either this value, ACMCertificateArn, or CloudFrontDefaultCertificate.
    - aCMCertificateArn
```
String aCMCertificateArn
```
      If you want viewers to use HTTPS to request your objects and you're using an alternate domain name in your object URLs (for example, https://example.com/logo.jpg), specify the ACM certificate ARN of the custom viewer certificate for this distribution. Specify either this value, IAMCertificateId, or CloudFrontDefaultCertificate.
    - sSLSupportMethod
```
String sSLSupportMethod
```
      If you specify a value for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests. Valid values are vip and sni-only. If you specify vip, CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you must request permission to use this feature, and you incur additional monthly charges. If you specify sni-only, CloudFront can only respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. Do not specify a value for SSLSupportMethod if you specified true for CloudFrontDefaultCertificate.
    - minimumProtocolVersion
```
String minimumProtocolVersion
```
      Specify the minimum version of the SSL protocol that you want CloudFront to use, SSLv3 or TLSv1, for HTTPS connections. CloudFront will serve your objects only to browsers or devices that support at least the SSL version that you specify. The TLSv1 protocol is more secure, so we recommend that you specify SSLv3 only if your users are using browsers or devices that don't support TLSv1. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using dedicated IP (if you specify vip for SSLSupportMethod), you can choose SSLv3 or TLSv1 as the MinimumProtocolVersion. If you're using a custom certificate (if you specify a value for IAMCertificateId) and if you're using SNI (if you specify sni-only for SSLSupportMethod), you must specify TLSv1 for MinimumProtocolVersion.
    - certificate
```
String certificate
```
      Deprecated.
      
      Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].
    - certificateSource
```
String certificateSource
```
      Deprecated.
      
      Note: this field is deprecated. Please use one of [ACMCertificateArn, IAMCertificateId, CloudFrontDefaultCertificate].
Package com.amazonaws.services.cloudhsm.model
- Class com.amazonaws.services.cloudhsm.model.AddTagsToResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource to tag.
    - tagList
```
com.amazonaws.internal.SdkInternalList<T> tagList
```
      One or more tags.
- Class com.amazonaws.services.cloudhsm.model.AddTagsToResourceResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the operation.
- Class com.amazonaws.services.cloudhsm.model.CloudHsmInternalException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudhsm.model.CloudHsmServiceException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudhsm.model.CreateHapgRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - label
```
String label
```
      The label of the new high-availability partition group.
- Class com.amazonaws.services.cloudhsm.model.CreateHapgResult extends Object implements Serializable
  - Serialized Fields
    - hapgArn
```
String hapgArn
```
      The ARN of the high-availability partition group.
- Class com.amazonaws.services.cloudhsm.model.CreateHsmRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subnetId
```
String subnetId
```
      The identifier of the subnet in your VPC in which to place the HSM.
    - sshKey
```
String sshKey
```
      The SSH public key to install on the HSM.
    - eniIp
```
String eniIp
```
      The IP address to assign to the HSM's ENI.
      
      If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.
    - iamRoleArn
```
String iamRoleArn
```
      The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.
    - externalId
```
String externalId
```
      The external ID from IamRoleArn, if present.
    - subscriptionType
```
String subscriptionType
```
    - clientToken
```
String clientToken
```
      A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.
    - syslogIp
```
String syslogIp
```
      The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
- Class com.amazonaws.services.cloudhsm.model.CreateHsmResult extends Object implements Serializable
  - Serialized Fields
    - hsmArn
```
String hsmArn
```
      The ARN of the HSM.
- Class com.amazonaws.services.cloudhsm.model.CreateLunaClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - label
```
String label
```
      The label for the client.
    - certificate
```
String certificate
```
      The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.
- Class com.amazonaws.services.cloudhsm.model.CreateLunaClientResult extends Object implements Serializable
  - Serialized Fields
    - clientArn
```
String clientArn
```
      The ARN of the client.
- Class com.amazonaws.services.cloudhsm.model.DeleteHapgRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hapgArn
```
String hapgArn
```
      The ARN of the high-availability partition group to delete.
- Class com.amazonaws.services.cloudhsm.model.DeleteHapgResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the action.
- Class com.amazonaws.services.cloudhsm.model.DeleteHsmRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hsmArn
```
String hsmArn
```
      The ARN of the HSM to delete.
- Class com.amazonaws.services.cloudhsm.model.DeleteHsmResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the operation.
- Class com.amazonaws.services.cloudhsm.model.DeleteLunaClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientArn
```
String clientArn
```
      The ARN of the client to delete.
- Class com.amazonaws.services.cloudhsm.model.DeleteLunaClientResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the action.
- Class com.amazonaws.services.cloudhsm.model.DescribeHapgRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hapgArn
```
String hapgArn
```
      The ARN of the high-availability partition group to describe.
- Class com.amazonaws.services.cloudhsm.model.DescribeHapgResult extends Object implements Serializable
  - Serialized Fields
    - hapgArn
```
String hapgArn
```
      The ARN of the high-availability partition group.
    - hapgSerial
```
String hapgSerial
```
      The serial number of the high-availability partition group.
    - hsmsLastActionFailed
```
com.amazonaws.internal.SdkInternalList<T> hsmsLastActionFailed
```
    - hsmsPendingDeletion
```
com.amazonaws.internal.SdkInternalList<T> hsmsPendingDeletion
```
    - hsmsPendingRegistration
```
com.amazonaws.internal.SdkInternalList<T> hsmsPendingRegistration
```
    - label
```
String label
```
      The label for the high-availability partition group.
    - lastModifiedTimestamp
```
String lastModifiedTimestamp
```
      The date and time the high-availability partition group was last modified.
    - partitionSerialList
```
com.amazonaws.internal.SdkInternalList<T> partitionSerialList
```
      The list of partition serial numbers that belong to the high-availability partition group.
    - state
```
String state
```
      The state of the high-availability partition group.
- Class com.amazonaws.services.cloudhsm.model.DescribeHsmRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hsmArn
```
String hsmArn
```
      The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be specified.
    - hsmSerialNumber
```
String hsmSerialNumber
```
      The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter must be specified.
- Class com.amazonaws.services.cloudhsm.model.DescribeHsmResult extends Object implements Serializable
  - Serialized Fields
    - hsmArn
```
String hsmArn
```
      The ARN of the HSM.
    - status
```
String status
```
      The status of the HSM.
    - statusDetails
```
String statusDetails
```
      Contains additional information about the status of the HSM.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone that the HSM is in.
    - eniId
```
String eniId
```
      The identifier of the elastic network interface (ENI) attached to the HSM.
    - eniIp
```
String eniIp
```
      The IP address assigned to the HSM's ENI.
    - subscriptionType
```
String subscriptionType
```
    - subscriptionStartDate
```
String subscriptionStartDate
```
      The subscription start date.
    - subscriptionEndDate
```
String subscriptionEndDate
```
      The subscription end date.
    - vpcId
```
String vpcId
```
      The identifier of the VPC that the HSM is in.
    - subnetId
```
String subnetId
```
      The identifier of the subnet that the HSM is in.
    - iamRoleArn
```
String iamRoleArn
```
      The ARN of the IAM role assigned to the HSM.
    - serialNumber
```
String serialNumber
```
      The serial number of the HSM.
    - vendorName
```
String vendorName
```
      The name of the HSM vendor.
    - hsmType
```
String hsmType
```
      The HSM model type.
    - softwareVersion
```
String softwareVersion
```
      The HSM software version.
    - sshPublicKey
```
String sshPublicKey
```
      The public SSH key.
    - sshKeyLastUpdated
```
String sshKeyLastUpdated
```
      The date and time that the SSH key was last updated.
    - serverCertUri
```
String serverCertUri
```
      The URI of the certificate server.
    - serverCertLastUpdated
```
String serverCertLastUpdated
```
      The date and time that the server certificate was last updated.
    - partitions
```
com.amazonaws.internal.SdkInternalList<T> partitions
```
      The list of partitions on the HSM.
- Class com.amazonaws.services.cloudhsm.model.DescribeLunaClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientArn
```
String clientArn
```
      The ARN of the client.
    - certificateFingerprint
```
String certificateFingerprint
```
      The certificate fingerprint.
- Class com.amazonaws.services.cloudhsm.model.DescribeLunaClientResult extends Object implements Serializable
  - Serialized Fields
    - clientArn
```
String clientArn
```
      The ARN of the client.
    - certificate
```
String certificate
```
      The certificate installed on the HSMs used by this client.
    - certificateFingerprint
```
String certificateFingerprint
```
      The certificate fingerprint.
    - lastModifiedTimestamp
```
String lastModifiedTimestamp
```
      The date and time the client was last modified.
    - label
```
String label
```
      The label of the client.
- Class com.amazonaws.services.cloudhsm.model.GetConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientArn
```
String clientArn
```
      The ARN of the client.
    - clientVersion
```
String clientVersion
```
      The client version.
    - hapgList
```
com.amazonaws.internal.SdkInternalList<T> hapgList
```
      A list of ARNs that identify the high-availability partition groups that are associated with the client.
- Class com.amazonaws.services.cloudhsm.model.GetConfigResult extends Object implements Serializable
  - Serialized Fields
    - configType
```
String configType
```
      The type of credentials.
    - configFile
```
String configFile
```
      The chrystoki.conf configuration file.
    - configCred
```
String configCred
```
      The certificate file containing the server.pem files of the HSMs.
- Class com.amazonaws.services.cloudhsm.model.InvalidRequestException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudhsm.model.ListAvailableZonesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.cloudhsm.model.ListAvailableZonesResult extends Object implements Serializable
  - Serialized Fields
    - aZList
```
com.amazonaws.internal.SdkInternalList<T> aZList
```
      The list of Availability Zones that have available AWS CloudHSM capacity.
- Class com.amazonaws.services.cloudhsm.model.ListHapgsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The NextToken value from a previous call to ListHapgs. Pass null if this is the first call.
- Class com.amazonaws.services.cloudhsm.model.ListHapgsResult extends Object implements Serializable
  - Serialized Fields
    - hapgList
```
com.amazonaws.internal.SdkInternalList<T> hapgList
```
      The list of high-availability partition groups.
    - nextToken
```
String nextToken
```
      If not null, more results are available. Pass this value to ListHapgs to retrieve the next set of items.
- Class com.amazonaws.services.cloudhsm.model.ListHsmsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The NextToken value from a previous call to ListHsms. Pass null if this is the first call.
- Class com.amazonaws.services.cloudhsm.model.ListHsmsResult extends Object implements Serializable
  - Serialized Fields
    - hsmList
```
com.amazonaws.internal.SdkInternalList<T> hsmList
```
      The list of ARNs that identify the HSMs.
    - nextToken
```
String nextToken
```
      If not null, more results are available. Pass this value to ListHsms to retrieve the next set of items.
- Class com.amazonaws.services.cloudhsm.model.ListLunaClientsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The NextToken value from a previous call to ListLunaClients. Pass null if this is the first call.
- Class com.amazonaws.services.cloudhsm.model.ListLunaClientsResult extends Object implements Serializable
  - Serialized Fields
    - clientList
```
com.amazonaws.internal.SdkInternalList<T> clientList
```
      The list of clients.
    - nextToken
```
String nextToken
```
      If not null, more results are available. Pass this to ListLunaClients to retrieve the next set of items.
- Class com.amazonaws.services.cloudhsm.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
- Class com.amazonaws.services.cloudhsm.model.ListTagsForResourceResult extends Object implements Serializable
  - Serialized Fields
    - tagList
```
com.amazonaws.internal.SdkInternalList<T> tagList
```
      One or more tags.
- Class com.amazonaws.services.cloudhsm.model.ModifyHapgRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hapgArn
```
String hapgArn
```
      The ARN of the high-availability partition group to modify.
    - label
```
String label
```
      The new label for the high-availability partition group.
    - partitionSerialList
```
com.amazonaws.internal.SdkInternalList<T> partitionSerialList
```
      The list of partition serial numbers to make members of the high-availability partition group.
- Class com.amazonaws.services.cloudhsm.model.ModifyHapgResult extends Object implements Serializable
  - Serialized Fields
    - hapgArn
```
String hapgArn
```
      The ARN of the high-availability partition group.
- Class com.amazonaws.services.cloudhsm.model.ModifyHsmRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hsmArn
```
String hsmArn
```
      The ARN of the HSM to modify.
    - subnetId
```
String subnetId
```
      The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.
    - eniIp
```
String eniIp
```
      The new IP address for the elastic network interface (ENI) attached to the HSM.
      
      If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.
    - iamRoleArn
```
String iamRoleArn
```
      The new IAM role ARN.
    - externalId
```
String externalId
```
      The new external ID.
    - syslogIp
```
String syslogIp
```
      The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.
- Class com.amazonaws.services.cloudhsm.model.ModifyHsmResult extends Object implements Serializable
  - Serialized Fields
    - hsmArn
```
String hsmArn
```
      The ARN of the HSM.
- Class com.amazonaws.services.cloudhsm.model.ModifyLunaClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientArn
```
String clientArn
```
      The ARN of the client.
    - certificate
```
String certificate
```
      The new certificate for the client.
- Class com.amazonaws.services.cloudhsm.model.ModifyLunaClientResult extends Object implements Serializable
  - Serialized Fields
    - clientArn
```
String clientArn
```
      The ARN of the client.
- Class com.amazonaws.services.cloudhsm.model.RemoveTagsFromResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the resource.
    - tagKeyList
```
com.amazonaws.internal.SdkInternalList<T> tagKeyList
```
      The tag key or keys to remove.
      
      Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
- Class com.amazonaws.services.cloudhsm.model.RemoveTagsFromResourceResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the operation.
- Class com.amazonaws.services.cloudhsm.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key of the tag.
    - value
```
String value
```
      The value of the tag.
Package com.amazonaws.services.cloudsearch.model
- Class com.amazonaws.services.cloudsearch.model.AccessPoliciesStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
String options
```
      Deprecated.
      
      An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.
      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"] } }} ] }
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.AvailabilityOptionsStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
Boolean options
```
      Deprecated.
      
      The availability options configured for the domain.
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.BaseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
      Deprecated.
- Class com.amazonaws.services.cloudsearch.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.CreateDomainResult extends Object implements Serializable
  - Serialized Fields
    - domainStatus
```
DomainStatus domainStatus
```
      Deprecated.
      
      The current status of the search domain.
- Class com.amazonaws.services.cloudsearch.model.DefaultSearchFieldStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
String options
```
      Deprecated.
      
      The name of the 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_]*
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.DefineIndexFieldRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - indexField
```
IndexField indexField
```
      Deprecated.
      
      Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.
- Class com.amazonaws.services.cloudsearch.model.DefineIndexFieldResult extends Object implements Serializable
  - Serialized Fields
    - indexField
```
IndexFieldStatus indexField
```
      Deprecated.
      
      The value of an IndexField and its current status.
- Class com.amazonaws.services.cloudsearch.model.DefineRankExpressionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - rankExpression
```
NamedRankExpression rankExpression
```
      Deprecated.
      
      A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.
- Class com.amazonaws.services.cloudsearch.model.DefineRankExpressionResult extends Object implements Serializable
  - Serialized Fields
    - rankExpression
```
RankExpressionStatus rankExpression
```
      Deprecated.
      
      The value of a RankExpression and its current status.
- Class com.amazonaws.services.cloudsearch.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.DeleteDomainResult extends Object implements Serializable
  - Serialized Fields
    - domainStatus
```
DomainStatus domainStatus
```
      Deprecated.
      
      The current status of the search domain.
- Class com.amazonaws.services.cloudsearch.model.DeleteIndexFieldRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - indexFieldName
```
String indexFieldName
```
      Deprecated.
      
      A string that represents the name of an index field. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
- Class com.amazonaws.services.cloudsearch.model.DeleteIndexFieldResult extends Object implements Serializable
  - Serialized Fields
    - indexField
```
IndexFieldStatus indexField
```
      Deprecated.
      
      The value of an IndexField and its current status.
- Class com.amazonaws.services.cloudsearch.model.DeleteRankExpressionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - rankName
```
String rankName
```
      Deprecated.
      
      The name of the RankExpression to delete.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
- Class com.amazonaws.services.cloudsearch.model.DeleteRankExpressionResult extends Object implements Serializable
  - Serialized Fields
    - rankExpression
```
RankExpressionStatus rankExpression
```
      Deprecated.
      
      The value of a RankExpression and its current status.
- Class com.amazonaws.services.cloudsearch.model.DescribeAvailabilityOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      The name of the domain you want to describe.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.DescribeAvailabilityOptionsResult extends Object implements Serializable
  - Serialized Fields
    - availabilityOptions
```
AvailabilityOptionsStatus availabilityOptions
```
      Deprecated.
      
      The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
- Class com.amazonaws.services.cloudsearch.model.DescribeDefaultSearchFieldRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.DescribeDefaultSearchFieldResult extends Object implements Serializable
  - Serialized Fields
    - defaultSearchField
```
DefaultSearchFieldStatus defaultSearchField
```
      Deprecated.
      
      The name of the IndexField to use for search requests issued with the q parameter. The default is the empty string, which automatically searches all text fields.
- Class com.amazonaws.services.cloudsearch.model.DescribeDomainsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
```
      Deprecated.
      
      Limits the DescribeDomains response to the specified search domains.
- Class com.amazonaws.services.cloudsearch.model.DescribeDomainsResult extends Object implements Serializable
  - Serialized Fields
    - domainStatusList
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
```
      Deprecated.
      
      The current status of all of your search domains.
- Class com.amazonaws.services.cloudsearch.model.DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - fieldNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
```
      Deprecated.
      
      Limits the DescribeIndexFields response to the specified fields.
- Class com.amazonaws.services.cloudsearch.model.DescribeIndexFieldsResult extends Object implements Serializable
  - Serialized Fields
    - indexFields
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
```
      Deprecated.
      
      The index fields configured for the domain.
- Class com.amazonaws.services.cloudsearch.model.DescribeRankExpressionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - rankNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> rankNames
```
      Deprecated.
      
      Limits the DescribeRankExpressions response to the specified fields.
- Class com.amazonaws.services.cloudsearch.model.DescribeRankExpressionsResult extends Object implements Serializable
  - Serialized Fields
    - rankExpressions
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> rankExpressions
```
      Deprecated.
      
      The rank expressions configured for the domain.
- Class com.amazonaws.services.cloudsearch.model.DescribeServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.DescribeServiceAccessPoliciesResult extends Object implements Serializable
  - Serialized Fields
    - accessPolicies
```
AccessPoliciesStatus accessPolicies
```
      Deprecated.
      
      A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.
- Class com.amazonaws.services.cloudsearch.model.DescribeStemmingOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.DescribeStemmingOptionsResult extends Object implements Serializable
  - Serialized Fields
    - stems
```
StemmingOptionsStatus stems
```
      Deprecated.
      
      The stemming options configured for this search domain and the current status of those options.
- Class com.amazonaws.services.cloudsearch.model.DescribeStopwordOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.DescribeStopwordOptionsResult extends Object implements Serializable
  - Serialized Fields
    - stopwords
```
StopwordOptionsStatus stopwords
```
      Deprecated.
      
      The stopword options configured for this search domain and the current status of those options.
- Class com.amazonaws.services.cloudsearch.model.DescribeSynonymOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.DescribeSynonymOptionsResult extends Object implements Serializable
  - Serialized Fields
    - synonyms
```
SynonymOptionsStatus synonyms
```
      Deprecated.
      
      The synonym options configured for this search domain and the current status of those options.
- Class com.amazonaws.services.cloudsearch.model.DisabledOperationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearch.model.DomainStatus extends Object implements Serializable
  - Serialized Fields
    - domainId
```
String domainId
```
      Deprecated.
      
      An internally generated unique identifier for a domain.
      Constraints:
      Length: 1 - 64
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - created
```
Boolean created
```
      Deprecated.
      
      True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    - deleted
```
Boolean deleted
```
      Deprecated.
      
      True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    - numSearchableDocs
```
Long numSearchableDocs
```
      Deprecated.
      
      The number of documents that have been submitted to the domain and indexed.
      Constraints:
      Range: 0 -
    - docService
```
ServiceEndpoint docService
```
      Deprecated.
      
      The service endpoint for updating documents in a search domain.
    - searchService
```
ServiceEndpoint searchService
```
      Deprecated.
      
      The service endpoint for requesting search results from a search domain.
    - requiresIndexDocuments
```
Boolean requiresIndexDocuments
```
      Deprecated.
      
      True if IndexDocuments needs to be called to activate the current domain configuration.
    - processing
```
Boolean processing
```
      Deprecated.
      
      True if processing is being done to activate the current domain configuration.
    - searchInstanceType
```
String searchInstanceType
```
      Deprecated.
      
      The instance type (such as search.m1.small) that is being used to process search requests.
    - searchPartitionCount
```
Integer searchPartitionCount
```
      Deprecated.
      
      The number of partitions across which the search index is spread.
      Constraints:
      Range: 1 -
    - searchInstanceCount
```
Integer searchInstanceCount
```
      Deprecated.
      
      The number of search instances that are available to process search requests.
      Constraints:
      Range: 1 -
- Class com.amazonaws.services.cloudsearch.model.IndexDocumentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearch.model.IndexDocumentsResult extends Object implements Serializable
  - Serialized Fields
    - fieldNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
```
      Deprecated.
      
      The names of the fields that are currently being processed due to an IndexDocuments action.
- Class com.amazonaws.services.cloudsearch.model.IndexField extends Object implements Serializable
  - Serialized Fields
    - indexFieldName
```
String indexFieldName
```
      Deprecated.
      
      The name of a field in the search index. Field names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - indexFieldType
```
String indexFieldType
```
      Deprecated.
      
      The type of field. Based on this type, exactly one of the UIntOptions, LiteralOptions or TextOptions must be present.
      Constraints:
      Allowed Values: uint, literal, text
    - uIntOptions
```
UIntOptions uIntOptions
```
      Deprecated.
      
      Options for an unsigned integer field. Present if IndexFieldType specifies the field is of type unsigned integer.
    - literalOptions
```
LiteralOptions literalOptions
```
      Deprecated.
      
      Options for literal field. Present if IndexFieldType specifies the field is of type literal.
    - textOptions
```
TextOptions textOptions
```
      Deprecated.
      
      Options for text field. Present if IndexFieldType specifies the field is of type text.
    - sourceAttributes
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceAttributes
```
      Deprecated.
      
      An optional list of source attributes that provide data for this index field. If not specified, the data is pulled from a source attribute with the same name as this 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.
- Class com.amazonaws.services.cloudsearch.model.IndexFieldStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
IndexField options
```
      Deprecated.
      
      Defines a field in the index, including its name, type, and the source of its data. The IndexFieldType indicates which of the options will be present. It is invalid to specify options for a type other than the IndexFieldType.
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.InternalException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearch.model.InvalidTypeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearch.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearch.model.LiteralOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      Deprecated.
      
      The default value for a literal field. Optional.
      Constraints:
      Length: 0 - 1024
    - searchEnabled
```
Boolean searchEnabled
```
      Deprecated.
      
      Specifies whether search is enabled for this field. Default: False.
    - facetEnabled
```
Boolean facetEnabled
```
      Deprecated.
      
      Specifies whether facets are enabled for this field. Default: False.
    - resultEnabled
```
Boolean resultEnabled
```
      Deprecated.
      
      Specifies whether values of this field can be returned in search results and used for ranking. Default: False.
- Class com.amazonaws.services.cloudsearch.model.NamedRankExpression extends Object implements Serializable
  - Serialized Fields
    - rankName
```
String rankName
```
      Deprecated.
      
      The name of a rank expression. Rank expression names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Uppercase letters and hyphens are not allowed. The names "body", "docid", and "text_relevance" are reserved and cannot be specified as field or rank expression names.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - rankExpression
```
String rankExpression
```
      Deprecated.
      The expression to evaluate for ranking or thresholding while processing a search request. The RankExpression syntax is based on JavaScript expressions and supports:
      
      Integer, floating point, hex and octal literals
      
      Shortcut evaluation of logical operators such that an expression a || b evaluates to the value a, if a is true, without evaluating b at all
      
      JavaScript order of precedence for operators
      
      Arithmetic operators: + - * / %
      
      Boolean operators (including the ternary operator)
      
      Bitwise operators
      
      Comparison operators
      
      Common mathematic functions: abs ceil erf exp floor lgamma ln log2 log10 max min sqrt pow
      
      Trigonometric library functions: acosh acos asinh asin atanh atan cosh cos sinh sin tanh tan
      
      Random generation of a number between 0 and 1: rand
      
      Current time in epoch: time
      
      The min max functions that operate on a variable argument list
      
      Intermediate 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
- Class com.amazonaws.services.cloudsearch.model.OptionStatus extends Object implements Serializable
  - Serialized Fields
    - creationDate
```
Date creationDate
```
      Deprecated.
      
      A timestamp for when this option was created.
    - updateDate
```
Date updateDate
```
      Deprecated.
      
      A timestamp for when this option was last updated.
    - updateVersion
```
Integer updateVersion
```
      Deprecated.
      
      A unique integer that indicates when this option was last updated.
      Constraints:
      Range: 0 -
    - state
```
String state
```
      Deprecated.
      The state of processing a change to an option. Possible values:
      
      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
    - pendingDeletion
```
Boolean pendingDeletion
```
      Deprecated.
      
      Indicates that the option will be deleted once processing is complete.
- Class com.amazonaws.services.cloudsearch.model.RankExpressionStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
NamedRankExpression options
```
      Deprecated.
      
      The expression that is evaluated for ranking or thresholding while processing a search request.
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearch.model.ServiceEndpoint extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Deprecated.
      
      An Amazon Resource Name (ARN). See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
    - endpoint
```
String endpoint
```
      Deprecated.
      
      The URL (including /version/pathPrefix) to which service requests can be submitted.
- Class com.amazonaws.services.cloudsearch.model.SourceAttribute extends Object implements Serializable
  - Serialized Fields
    - sourceDataFunction
```
String sourceDataFunction
```
      Deprecated.
      
      Identifies the transformation to apply when copying data from a source attribute.
      Constraints:
      Allowed Values: Copy, TrimTitle, Map
    - sourceDataCopy
```
SourceData sourceDataCopy
```
      Deprecated.
      
      Copies data from a source document attribute to an IndexField.
    - sourceDataTrimTitle
```
SourceDataTrimTitle sourceDataTrimTitle
```
      Deprecated.
      
      Trims common title words from a source document attribute when populating an IndexField. This can be used to create an IndexField you can use for sorting.
    - sourceDataMap
```
SourceDataMap sourceDataMap
```
      Deprecated.
      
      Maps source document attribute values to new values when populating the IndexField.
- Class com.amazonaws.services.cloudsearch.model.SourceData extends Object implements Serializable
  - Serialized Fields
    - sourceName
```
String sourceName
```
      Deprecated.
      
      The name of the document source field to add to this IndexField.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - defaultValue
```
String defaultValue
```
      Deprecated.
      
      The default value to use if the source attribute is not specified in a document. Optional.
      Constraints:
      Length: 0 - 1024
- Class com.amazonaws.services.cloudsearch.model.SourceDataMap extends Object implements Serializable
  - Serialized Fields
    - sourceName
```
String sourceName
```
      Deprecated.
      
      The name of the document source field to add to this IndexField.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - defaultValue
```
String defaultValue
```
      Deprecated.
      
      The default value to use if the source attribute is not specified in a document. Optional.
      Constraints:
      Length: 0 - 1024
    - cases
```
Map<K,V> cases
```
      Deprecated.
      
      A map that translates source field values to custom values.
- Class com.amazonaws.services.cloudsearch.model.SourceDataTrimTitle extends Object implements Serializable
  - Serialized Fields
    - sourceName
```
String sourceName
```
      Deprecated.
      
      The name of the document source field to add to this IndexField.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - defaultValue
```
String defaultValue
```
      Deprecated.
      
      The default value to use if the source attribute is not specified in a document. Optional.
      Constraints:
      Length: 0 - 1024
    - separator
```
String separator
```
      Deprecated.
      
      The separator that follows the text to trim.
    - language
```
String language
```
      Deprecated.
      
      An IETF RFC 4646 language code. Only the primary language is considered. English (en) is currently the only supported language.
      Constraints:
      Pattern: [a-zA-Z]{2,8}(?:-[a-zA-Z]{2,8})*
- Class com.amazonaws.services.cloudsearch.model.StemmingOptionsStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
String options
```
      Deprecated.
      
      Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { "stems": {"people": "person", "walking": "walk"} }
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.StopwordOptionsStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
String options
```
      Deprecated.
      
      Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { "stopwords": ["a", "an", "the", "of"] }
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.SynonymOptionsStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
String options
```
      Deprecated.
      
      Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }
    - status
```
OptionStatus status
```
      Deprecated.
      
      The status of an option, including when it was last updated and whether it is actively in use for searches.
- Class com.amazonaws.services.cloudsearch.model.TextOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      Deprecated.
      
      The default value for a text field. Optional.
      Constraints:
      Length: 0 - 1024
    - facetEnabled
```
Boolean facetEnabled
```
      Deprecated.
      
      Specifies whether facets are enabled for this field. Default: False.
    - resultEnabled
```
Boolean resultEnabled
```
      Deprecated.
      
      Specifies whether values of this field can be returned in search results and used for ranking. Default: False.
    - textProcessor
```
String textProcessor
```
      Deprecated.
      The text processor to apply to this field. Optional. Possible values:
      
      cs_text_no_stemming: turns off stemming for the field.
      
      Default: none
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
- Class com.amazonaws.services.cloudsearch.model.UIntOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
Integer defaultValue
```
      Deprecated.
      
      The default value for an unsigned integer field. Optional.
      Constraints:
      Range: 0 -
- Class com.amazonaws.services.cloudsearch.model.UpdateAvailabilityOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - multiAZ
```
Boolean multiAZ
```
      Deprecated.
      
      You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.
- Class com.amazonaws.services.cloudsearch.model.UpdateAvailabilityOptionsResult extends Object implements Serializable
  - Serialized Fields
    - availabilityOptions
```
AvailabilityOptionsStatus availabilityOptions
```
      Deprecated.
      
      The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
- Class com.amazonaws.services.cloudsearch.model.UpdateDefaultSearchFieldRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - defaultSearchField
```
String defaultSearchField
```
      Deprecated.
      
      The text field to search if the search request does not specify which field to search. The default search field is used when search terms are specified with the 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.
- Class com.amazonaws.services.cloudsearch.model.UpdateDefaultSearchFieldResult extends Object implements Serializable
  - Serialized Fields
    - defaultSearchField
```
DefaultSearchFieldStatus defaultSearchField
```
      Deprecated.
      
      The value of the DefaultSearchField configured for this search domain and its current status.
- Class com.amazonaws.services.cloudsearch.model.UpdateServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - accessPolicies
```
String accessPolicies
```
      Deprecated.
      
      An IAM access policy as described in The Access Policy Language in Using AWS Identity and Access Management. The maximum size of an access policy document is 100 KB.
      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"] } }} ] }
- Class com.amazonaws.services.cloudsearch.model.UpdateServiceAccessPoliciesResult extends Object implements Serializable
  - Serialized Fields
    - accessPolicies
```
AccessPoliciesStatus accessPolicies
```
      Deprecated.
      
      A PolicyDocument that specifies access policies for the search domain's services, and the current status of those policies.
- Class com.amazonaws.services.cloudsearch.model.UpdateStemmingOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - stems
```
String stems
```
      Deprecated.
      
      Maps terms to their stems, serialized as a JSON document. The document has a single object with one property "stems" whose value is an object mapping terms to their stems. The maximum size of a stemming document is 500 KB. Example: { "stems": {"people": "person", "walking": "walk"} }
- Class com.amazonaws.services.cloudsearch.model.UpdateStemmingOptionsResult extends Object implements Serializable
  - Serialized Fields
    - stems
```
StemmingOptionsStatus stems
```
      Deprecated.
      
      The stemming options configured for this search domain and the current status of those options.
- Class com.amazonaws.services.cloudsearch.model.UpdateStopwordOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - stopwords
```
String stopwords
```
      Deprecated.
      
      Lists stopwords serialized as a JSON document. The document has a single object with one property "stopwords" whose value is an array of strings. The maximum size of a stopwords document is 10 KB. Example: { "stopwords": ["a", "an", "the", "of"] }
- Class com.amazonaws.services.cloudsearch.model.UpdateStopwordOptionsResult extends Object implements Serializable
  - Serialized Fields
    - stopwords
```
StopwordOptionsStatus stopwords
```
      Deprecated.
      
      The stopword options configured for this search domain and the current status of those options.
- Class com.amazonaws.services.cloudsearch.model.UpdateSynonymOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      Deprecated.
      
      A string that represents the name of a domain. Domain names must be 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). Uppercase letters and underscores are not allowed.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - synonyms
```
String synonyms
```
      Deprecated.
      
      Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }
- Class com.amazonaws.services.cloudsearch.model.UpdateSynonymOptionsResult extends Object implements Serializable
  - Serialized Fields
    - synonyms
```
SynonymOptionsStatus synonyms
```
      Deprecated.
      
      The synonym options configured for this search domain and the current status of those options.
Package com.amazonaws.services.cloudsearchdomain.model
- Class com.amazonaws.services.cloudsearchdomain.model.Bucket extends Object implements Serializable
  - Serialized Fields
    - value
```
String value
```
      The facet value being counted.
    - count
```
Long count
```
      The number of hits that contain the facet value in the specified facet field.
- Class com.amazonaws.services.cloudsearchdomain.model.BucketInfo extends Object implements Serializable
  - Serialized Fields
    - buckets
```
com.amazonaws.internal.SdkInternalList<T> buckets
```
      A list of the calculated facet values and counts.
- Class com.amazonaws.services.cloudsearchdomain.model.DocumentServiceException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - status
```
String status
```
      The return status of a document upload request, error or success.
- Class com.amazonaws.services.cloudsearchdomain.model.DocumentServiceWarning extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      The description for a warning returned by the document service.
- Class com.amazonaws.services.cloudsearchdomain.model.FieldStats extends Object implements Serializable
  - Serialized Fields
    - min
```
String min
```
      The minimum value found in the specified field in the result set.
      
      If the field is numeric (int, int-array, double, or double-array), min is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, min is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
    - max
```
String max
```
      The maximum value found in the specified field in the result set.
      
      If the field is numeric (int, int-array, double, or double-array), max is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, max is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
    - count
```
Long count
```
      The number of documents that contain a value in the specified field in the result set.
    - missing
```
Long missing
```
      The number of documents that do not contain a value in the specified field in the result set.
    - sum
```
Double sum
```
      The sum of the field values across the documents in the result set. null for date fields.
    - sumOfSquares
```
Double sumOfSquares
```
      The sum of all field values in the result set squared.
    - mean
```
String mean
```
      The average of the values found in the specified field in the result set.
      
      If the field is numeric (int, int-array, double, or double-array), mean is the string representation of a double-precision 64-bit floating point value. If the field is date or date-array, mean is the string representation of a date with the format specified in IETF RFC3339: yyyy-mm-ddTHH:mm:ss.SSSZ.
    - stddev
```
Double stddev
```
      The standard deviation of the values in the specified field in the result set.
- Class com.amazonaws.services.cloudsearchdomain.model.Hit extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The document ID of a document that matches the search request.
    - fields
```
com.amazonaws.internal.SdkInternalMap<K,V> fields
```
      The fields returned from a document that matches the search request.
    - exprs
```
com.amazonaws.internal.SdkInternalMap<K,V> exprs
```
      The expressions returned from a document that matches the search request.
    - highlights
```
com.amazonaws.internal.SdkInternalMap<K,V> highlights
```
      The highlights returned from a document that matches the search request.
- Class com.amazonaws.services.cloudsearchdomain.model.Hits extends Object implements Serializable
  - Serialized Fields
    - found
```
Long found
```
      The total number of documents that match the search request.
    - start
```
Long start
```
      The index of the first matching document.
    - cursor
```
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.
    - hit
```
com.amazonaws.internal.SdkInternalList<T> hit
```
      A document that matches the search request.
- Class com.amazonaws.services.cloudsearchdomain.model.SearchException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearchdomain.model.SearchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - cursor
```
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.
    - expr
```
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.
    - facet
```
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.
    - filterQuery
```
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.
    - highlight
```
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": ""} }
    - partial
```
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.
    - query
```
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.
    - queryOptions
```
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.
    - queryParser
```
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.
    - returnValue
```
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 .
    - size
```
Long size
```
      Specifies the maximum number of search hits to include in the response.
    - sort
```
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.
    - start
```
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.
    - stats
```
String stats
```
      Specifies one or more fields for which to get statistics information. Each specified field must be facet-enabled in the domain configuration. The fields are specified in JSON using the form:
      {"FIELD-A":{},"FIELD-B":{}}
      There are currently no options supported for statistics.
- Class com.amazonaws.services.cloudsearchdomain.model.SearchResult extends Object implements Serializable
  - Serialized Fields
    - status
```
SearchStatus status
```
      The status information returned for the search request.
    - hits
```
Hits hits
```
      The documents that match the search criteria.
    - facets
```
com.amazonaws.internal.SdkInternalMap<K,V> facets
```
      The requested facet information.
    - stats
```
com.amazonaws.internal.SdkInternalMap<K,V> stats
```
      The requested field statistics information.
- Class com.amazonaws.services.cloudsearchdomain.model.SearchStatus extends Object implements Serializable
  - Serialized Fields
    - timems
```
Long timems
```
      How long it took to process the request, in milliseconds.
    - rid
```
String rid
```
      The encrypted resource ID for the request.
- Class com.amazonaws.services.cloudsearchdomain.model.SuggestionMatch extends Object implements Serializable
  - Serialized Fields
    - suggestion
```
String suggestion
```
      The string that matches the query string specified in the SuggestRequest.
    - score
```
Long score
```
      The relevance score of a suggested match.
    - id
```
String id
```
      The document ID of the suggested document.
- Class com.amazonaws.services.cloudsearchdomain.model.SuggestModel extends Object implements Serializable
  - Serialized Fields
    - query
```
String query
```
      The query string specified in the suggest request.
    - found
```
Long found
```
      The number of documents that were found to match the query string.
    - suggestions
```
com.amazonaws.internal.SdkInternalList<T> suggestions
```
      The documents that match the query string.
- Class com.amazonaws.services.cloudsearchdomain.model.SuggestRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - query
```
String query
```
      Specifies the string for which you want to get suggestions.
    - suggester
```
String suggester
```
      Specifies the name of the suggester to use to find suggested matches.
    - size
```
Long size
```
      Specifies the maximum number of suggestions to return.
- Class com.amazonaws.services.cloudsearchdomain.model.SuggestResult extends Object implements Serializable
  - Serialized Fields
    - status
```
SuggestStatus status
```
      The status of a SuggestRequest. Contains the resource ID ( rid) and how long it took to process the request ( timems).
    - suggest
```
SuggestModel suggest
```
      Container for the matching search suggestion information.
- Class com.amazonaws.services.cloudsearchdomain.model.SuggestStatus extends Object implements Serializable
  - Serialized Fields
    - timems
```
Long timems
```
      How long it took to process the request, in milliseconds.
    - rid
```
String rid
```
      The encrypted resource ID for the request.
- Class com.amazonaws.services.cloudsearchdomain.model.UploadDocumentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - documents
```
InputStream documents
```
      A batch of documents formatted in JSON or HTML.
    - contentType
```
String contentType
```
      The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:
      
      application/json
      
      application/xml
    - contentLength
```
Long contentLength
```
- Class com.amazonaws.services.cloudsearchdomain.model.UploadDocumentsResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of an UploadDocumentsRequest.
    - adds
```
Long adds
```
      The number of documents that were added to the search domain.
    - deletes
```
Long deletes
```
      The number of documents that were deleted from the search domain.
    - warnings
```
com.amazonaws.internal.SdkInternalList<T> warnings
```
      Any warnings returned by the document service about the documents being uploaded.
Package com.amazonaws.services.cloudsearchv2.model
- Class com.amazonaws.services.cloudsearchv2.model.AccessPoliciesStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
String options
```
      Access rules for a domain's document or search service endpoints. For more information, see Configuring Access for a Search Domain in the Amazon CloudSearch Developer Guide. The maximum size of a policy document is 100 KB.
    - status
```
OptionStatus status
```
      The status of domain configuration option.
- Class com.amazonaws.services.cloudsearchv2.model.AnalysisOptions extends Object implements Serializable
  - Serialized Fields
    - synonyms
```
String synonyms
```
      A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
    - stopwords
```
String stopwords
```
      A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
    - stemmingDictionary
```
String stemmingDictionary
```
      A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"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.
    - japaneseTokenizationDictionary
```
String japaneseTokenizationDictionary
```
      A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
    - algorithmicStemming
```
String algorithmicStemming
```
      The level of algorithmic stemming to perform: 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
- Class com.amazonaws.services.cloudsearchv2.model.AnalysisScheme extends Object implements Serializable
  - Serialized Fields
    - analysisSchemeName
```
String analysisSchemeName
```
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - analysisSchemeLanguage
```
String analysisSchemeLanguage
```
      An IETF RFC 4646 language code or 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 analysisOptions
```
      Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.
- Class com.amazonaws.services.cloudsearchv2.model.AnalysisSchemeStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
AnalysisScheme options
```
      Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.
    - status
```
OptionStatus status
```
      The status of domain configuration option.
- Class com.amazonaws.services.cloudsearchv2.model.AvailabilityOptionsStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
Boolean options
```
      The availability options configured for the domain.
    - status
```
OptionStatus status
```
      The status of domain configuration option.
- Class com.amazonaws.services.cloudsearchv2.model.BaseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - code
```
String code
```
- Class com.amazonaws.services.cloudsearchv2.model.BuildSuggestersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearchv2.model.BuildSuggestersResult extends Object implements Serializable
  - Serialized Fields
    - fieldNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
```
      A list of field names.
- Class com.amazonaws.services.cloudsearchv2.model.CreateDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearchv2.model.CreateDomainResult extends Object implements Serializable
  - Serialized Fields
    - domainStatus
```
DomainStatus domainStatus
```
      The current status of the search domain.
- Class com.amazonaws.services.cloudsearchv2.model.DateArrayOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      A value to use for the field if the field isn't specified for a document.
      Constraints:
      Length: 0 - 1024
    - sourceFields
```
String sourceFields
```
      A list of source fields to map to the field.
      Constraints:
      Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
- Class com.amazonaws.services.cloudsearchv2.model.DateOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      A value to use for the field if the field isn't specified for a document.
      Constraints:
      Length: 0 - 1024
    - sourceField
```
String sourceField
```
      A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
      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_]*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
    - sortEnabled
```
Boolean sortEnabled
```
      Whether the field can be used to sort the search results.
- Class com.amazonaws.services.cloudsearchv2.model.DefineAnalysisSchemeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - analysisScheme
```
AnalysisScheme analysisScheme
```
      Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: Synonyms, Stopwords, StemmingDictionary, JapaneseTokenizationDictionary and AlgorithmicStemming.
- Class com.amazonaws.services.cloudsearchv2.model.DefineAnalysisSchemeResult extends Object implements Serializable
  - Serialized Fields
    - analysisScheme
```
AnalysisSchemeStatus analysisScheme
```
      The status and configuration of an AnalysisScheme.
- Class com.amazonaws.services.cloudsearchv2.model.DefineExpressionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - expression
```
Expression expression
```
      A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.
- Class com.amazonaws.services.cloudsearchv2.model.DefineExpressionResult extends Object implements Serializable
  - Serialized Fields
    - expression
```
ExpressionStatus expression
```
      The value of an Expression and its current status.
- Class com.amazonaws.services.cloudsearchv2.model.DefineIndexFieldRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - indexField
```
IndexField indexField
```
      The index field and field options you want to configure.
- Class com.amazonaws.services.cloudsearchv2.model.DefineIndexFieldResult extends Object implements Serializable
  - Serialized Fields
    - indexField
```
IndexFieldStatus indexField
```
      The value of an IndexField and its current status.
- Class com.amazonaws.services.cloudsearchv2.model.DefineSuggesterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - suggester
```
Suggester suggester
```
      Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.
- Class com.amazonaws.services.cloudsearchv2.model.DefineSuggesterResult extends Object implements Serializable
  - Serialized Fields
    - suggester
```
SuggesterStatus suggester
```
      The value of a Suggester and its current status.
- Class com.amazonaws.services.cloudsearchv2.model.DeleteAnalysisSchemeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - analysisSchemeName
```
String analysisSchemeName
```
      The name of the analysis scheme you want to delete.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
- Class com.amazonaws.services.cloudsearchv2.model.DeleteAnalysisSchemeResult extends Object implements Serializable
  - Serialized Fields
    - analysisScheme
```
AnalysisSchemeStatus analysisScheme
```
      The status of the analysis scheme being deleted.
- Class com.amazonaws.services.cloudsearchv2.model.DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the domain you want to permanently delete.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearchv2.model.DeleteDomainResult extends Object implements Serializable
  - Serialized Fields
    - domainStatus
```
DomainStatus domainStatus
```
      The current status of the search domain.
- Class com.amazonaws.services.cloudsearchv2.model.DeleteExpressionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - expressionName
```
String expressionName
```
      The name of the Expression to delete.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
- Class com.amazonaws.services.cloudsearchv2.model.DeleteExpressionResult extends Object implements Serializable
  - Serialized Fields
    - expression
```
ExpressionStatus expression
```
      The status of the expression being deleted.
- Class com.amazonaws.services.cloudsearchv2.model.DeleteIndexFieldRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - indexFieldName
```
String indexFieldName
```
      The name of the index field your want to remove from the domain's indexing options.
      Constraints:
      Length: 1 - 64
      Pattern: ([a-z][a-z0-9_]*\*?|\*[a-z0-9_]*)
- Class com.amazonaws.services.cloudsearchv2.model.DeleteIndexFieldResult extends Object implements Serializable
  - Serialized Fields
    - indexField
```
IndexFieldStatus indexField
```
      The status of the index field being deleted.
- Class com.amazonaws.services.cloudsearchv2.model.DeleteSuggesterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - suggesterName
```
String suggesterName
```
      Specifies the name of the suggester you want to delete.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
- Class com.amazonaws.services.cloudsearchv2.model.DeleteSuggesterResult extends Object implements Serializable
  - Serialized Fields
    - suggester
```
SuggesterStatus suggester
```
      The status of the suggester being deleted.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeAnalysisSchemesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the domain you want to describe.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - analysisSchemeNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemeNames
```
      The analysis schemes you want to describe.
    - deployed
```
Boolean deployed
```
      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeAnalysisSchemesResult extends Object implements Serializable
  - Serialized Fields
    - analysisSchemes
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> analysisSchemes
```
      The analysis scheme descriptions.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeAvailabilityOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the domain you want to describe.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - deployed
```
Boolean deployed
```
      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeAvailabilityOptionsResult extends Object implements Serializable
  - Serialized Fields
    - availabilityOptions
```
AvailabilityOptionsStatus availabilityOptions
```
      The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeDomainsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainNames
```
      The names of the domains you want to include in the response.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeDomainsResult extends Object implements Serializable
  - Serialized Fields
    - domainStatusList
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainStatusList
```
      A list that contains the status of each requested domain.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the domain you want to describe.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - expressionNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> expressionNames
```
      Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.
    - deployed
```
Boolean deployed
```
      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsResult extends Object implements Serializable
  - Serialized Fields
    - expressions
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> expressions
```
      The expressions configured for the domain.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the domain you want to describe.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - fieldNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
```
      A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.
    - deployed
```
Boolean deployed
```
      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsResult extends Object implements Serializable
  - Serialized Fields
    - indexFields
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> indexFields
```
      The index fields configured for the domain.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeScalingParametersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearchv2.model.DescribeScalingParametersResult extends Object implements Serializable
  - Serialized Fields
    - scalingParameters
```
ScalingParametersStatus scalingParameters
```
      The status and configuration of a search domain's scaling parameters.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the domain you want to describe.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - deployed
```
Boolean deployed
```
      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeServiceAccessPoliciesResult extends Object implements Serializable
  - Serialized Fields
    - accessPolicies
```
AccessPoliciesStatus accessPolicies
```
      The access rules configured for the domain specified in the request.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      The name of the domain you want to describe.
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - suggesterNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesterNames
```
      The suggesters you want to describe.
    - deployed
```
Boolean deployed
```
      Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
- Class com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersResult extends Object implements Serializable
  - Serialized Fields
    - suggesters
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> suggesters
```
      The suggesters configured for the domain specified in the request.
- Class com.amazonaws.services.cloudsearchv2.model.DisabledOperationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearchv2.model.DocumentSuggesterOptions extends Object implements Serializable
  - Serialized Fields
    - sourceField
```
String sourceField
```
      The name of the index field you want to use for suggestions.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - fuzzyMatching
```
String fuzzyMatching
```
      The level of fuzziness allowed when suggesting matches for a string: 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
    - sortExpression
```
String sortExpression
```
      An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _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.
- Class com.amazonaws.services.cloudsearchv2.model.DomainStatus extends Object implements Serializable
  - Serialized Fields
    - domainId
```
String domainId
```
      An internally generated unique identifier for a domain.
      Constraints:
      Length: 1 - 64
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - aRN
```
String aRN
```
      The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
    - created
```
Boolean created
```
      True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.
    - deleted
```
Boolean deleted
```
      True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.
    - docService
```
ServiceEndpoint docService
```
      The service endpoint for updating documents in a search domain.
    - searchService
```
ServiceEndpoint searchService
```
      The service endpoint for requesting search results from a search domain.
    - requiresIndexDocuments
```
Boolean requiresIndexDocuments
```
      True if IndexDocuments needs to be called to activate the current domain configuration.
    - processing
```
Boolean processing
```
      True if processing is being done to activate the current domain configuration.
    - searchInstanceType
```
String searchInstanceType
```
      The instance type that is being used to process search requests.
    - searchPartitionCount
```
Integer searchPartitionCount
```
      The number of partitions across which the search index is spread.
      Constraints:
      Range: 1 -
    - searchInstanceCount
```
Integer searchInstanceCount
```
      The number of search instances that are available to process search requests.
      Constraints:
      Range: 1 -
    - limits
```
Limits limits
```
- Class com.amazonaws.services.cloudsearchv2.model.DoubleArrayOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
Double defaultValue
```
      A value to use for the field if the field isn't specified for a document.
    - sourceFields
```
String sourceFields
```
      A list of source fields to map to the field.
      Constraints:
      Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
- Class com.amazonaws.services.cloudsearchv2.model.DoubleOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
Double defaultValue
```
      A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
    - sourceField
```
String sourceField
```
      The name of the source field to map to the field.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
    - sortEnabled
```
Boolean sortEnabled
```
      Whether the field can be used to sort the search results.
- Class com.amazonaws.services.cloudsearchv2.model.Expression extends Object implements Serializable
  - Serialized Fields
    - expressionName
```
String expressionName
```
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - expressionValue
```
String expressionValue
```
      The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.
      Constraints:
      Length: 1 - 10240
- Class com.amazonaws.services.cloudsearchv2.model.ExpressionStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
Expression options
```
      The expression that is evaluated for sorting while processing a search request.
    - status
```
OptionStatus status
```
      The status of domain configuration option.
- Class com.amazonaws.services.cloudsearchv2.model.IndexDocumentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
- Class com.amazonaws.services.cloudsearchv2.model.IndexDocumentsResult extends Object implements Serializable
  - Serialized Fields
    - fieldNames
```
com.amazonaws.internal.ListWithAutoConstructFlag<T> fieldNames
```
      The names of the fields that are currently being indexed.
- Class com.amazonaws.services.cloudsearchv2.model.IndexField extends Object implements Serializable
  - Serialized Fields
    - indexFieldName
```
String indexFieldName
```
      A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
      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_]*)
    - indexFieldType
```
String indexFieldType
```
      The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
      Constraints:
      Allowed Values: int, double, literal, text, date, latlon, int-array, double-array, literal-array, text-array, date-array
    - intOptions
```
IntOptions intOptions
```
      Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.
    - doubleOptions
```
DoubleOptions doubleOptions
```
      Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.
    - literalOptions
```
LiteralOptions literalOptions
```
      Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.
    - textOptions
```
TextOptions textOptions
```
      Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.
    - dateOptions
```
DateOptions dateOptions
```
      Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.
    - latLonOptions
```
LatLonOptions latLonOptions
```
      Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.
    - intArrayOptions
```
IntArrayOptions intArrayOptions
```
      Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.
    - doubleArrayOptions
```
DoubleArrayOptions doubleArrayOptions
```
      Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.
    - literalArrayOptions
```
LiteralArrayOptions literalArrayOptions
```
      Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.
    - textArrayOptions
```
TextArrayOptions textArrayOptions
```
      Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.
    - dateArrayOptions
```
DateArrayOptions dateArrayOptions
```
      Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.
- Class com.amazonaws.services.cloudsearchv2.model.IndexFieldStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
IndexField options
```
      Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.
    - status
```
OptionStatus status
```
      The status of domain configuration option.
- Class com.amazonaws.services.cloudsearchv2.model.IntArrayOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
Long defaultValue
```
      A value to use for the field if the field isn't specified for a document.
    - sourceFields
```
String sourceFields
```
      A list of source fields to map to the field.
      Constraints:
      Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
- Class com.amazonaws.services.cloudsearchv2.model.InternalException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearchv2.model.IntOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
Long defaultValue
```
      A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
    - sourceField
```
String sourceField
```
      The name of the source field to map to the field.
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
    - sortEnabled
```
Boolean sortEnabled
```
      Whether the field can be used to sort the search results.
- Class com.amazonaws.services.cloudsearchv2.model.InvalidTypeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearchv2.model.LatLonOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      A value to use for the field if the field isn't specified for a document.
      Constraints:
      Length: 0 - 1024
    - sourceField
```
String sourceField
```
      A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
      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_]*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
    - sortEnabled
```
Boolean sortEnabled
```
      Whether the field can be used to sort the search results.
- Class com.amazonaws.services.cloudsearchv2.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearchv2.model.Limits extends Object implements Serializable
  - Serialized Fields
    - maximumReplicationCount
```
Integer maximumReplicationCount
```
    - maximumPartitionCount
```
Integer maximumPartitionCount
```
- Class com.amazonaws.services.cloudsearchv2.model.ListDomainNamesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.cloudsearchv2.model.ListDomainNamesResult extends Object implements Serializable
  - Serialized Fields
    - domainNames
```
Map<K,V> domainNames
```
      The names of the search domains owned by an account.
- Class com.amazonaws.services.cloudsearchv2.model.LiteralArrayOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      A value to use for the field if the field isn't specified for a document.
      Constraints:
      Length: 0 - 1024
    - sourceFields
```
String sourceFields
```
      A list of source fields to map to the field.
      Constraints:
      Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
- Class com.amazonaws.services.cloudsearchv2.model.LiteralOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      A value to use for the field if the field isn't specified for a document.
      Constraints:
      Length: 0 - 1024
    - sourceField
```
String sourceField
```
      A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
      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_]*
    - facetEnabled
```
Boolean facetEnabled
```
      Whether facet information can be returned for the field.
    - searchEnabled
```
Boolean searchEnabled
```
      Whether the contents of the field are searchable.
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
    - sortEnabled
```
Boolean sortEnabled
```
      Whether the field can be used to sort the search results.
- Class com.amazonaws.services.cloudsearchv2.model.OptionStatus extends Object implements Serializable
  - Serialized Fields
    - creationDate
```
Date creationDate
```
      A timestamp for when this option was created.
    - updateDate
```
Date updateDate
```
      A timestamp for when this option was last updated.
    - updateVersion
```
Integer updateVersion
```
      A unique integer that indicates when this option was last updated.
      Constraints:
      Range: 0 -
    - state
```
String state
```
      The state of processing a change to an option. Possible values:
      
      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
    - pendingDeletion
```
Boolean pendingDeletion
```
      Indicates that the option will be deleted once processing is complete.
- Class com.amazonaws.services.cloudsearchv2.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudsearchv2.model.ScalingParameters extends Object implements Serializable
  - Serialized Fields
    - desiredInstanceType
```
String desiredInstanceType
```
      The instance type that you want to preconfigure for your domain. For example, 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
    - desiredReplicationCount
```
Integer desiredReplicationCount
```
      The number of replicas you want to preconfigure for each index partition.
      Constraints:
      Range: 0 -
    - desiredPartitionCount
```
Integer desiredPartitionCount
```
      The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.
      Constraints:
      Range: 0 -
- Class com.amazonaws.services.cloudsearchv2.model.ScalingParametersStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
ScalingParameters options
```
      The desired instance type and desired number of replicas of each index partition.
    - status
```
OptionStatus status
```
      The status of domain configuration option.
- Class com.amazonaws.services.cloudsearchv2.model.ServiceEndpoint extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
String endpoint
```
      The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.
- Class com.amazonaws.services.cloudsearchv2.model.Suggester extends Object implements Serializable
  - Serialized Fields
    - suggesterName
```
String suggesterName
```
      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).
      Constraints:
      Length: 1 - 64
      Pattern: [a-z][a-z0-9_]*
    - documentSuggesterOptions
```
DocumentSuggesterOptions documentSuggesterOptions
```
      Options for a search suggester.
- Class com.amazonaws.services.cloudsearchv2.model.SuggesterStatus extends Object implements Serializable
  - Serialized Fields
    - options
```
Suggester options
```
      Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.
    - status
```
OptionStatus status
```
      The status of domain configuration option.
- Class com.amazonaws.services.cloudsearchv2.model.TextArrayOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      A value to use for the field if the field isn't specified for a document.
      Constraints:
      Length: 0 - 1024
    - sourceFields
```
String sourceFields
```
      A list of source fields to map to the field.
      Constraints:
      Pattern: \s*[a-z*][a-z0-9_]*\*?\s*(,\s*[a-z*][a-z0-9_]*\*?\s*)*
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
    - highlightEnabled
```
Boolean highlightEnabled
```
      Whether highlights can be returned for the field.
    - analysisScheme
```
String analysisScheme
```
      The name of an analysis scheme for a text-array field.
      Constraints:
      Pattern: [\S]+
- Class com.amazonaws.services.cloudsearchv2.model.TextOptions extends Object implements Serializable
  - Serialized Fields
    - defaultValue
```
String defaultValue
```
      A value to use for the field if the field isn't specified for a document.
      Constraints:
      Length: 0 - 1024
    - sourceField
```
String sourceField
```
      A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
      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_]*
    - returnEnabled
```
Boolean returnEnabled
```
      Whether the contents of the field can be returned in the search results.
    - sortEnabled
```
Boolean sortEnabled
```
      Whether the field can be used to sort the search results.
    - highlightEnabled
```
Boolean highlightEnabled
```
      Whether highlights can be returned for the field.
    - analysisScheme
```
String analysisScheme
```
      The name of an analysis scheme for a text field.
      Constraints:
      Pattern: [\S]+
- Class com.amazonaws.services.cloudsearchv2.model.UpdateAvailabilityOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - multiAZ
```
Boolean multiAZ
```
      You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.
- Class com.amazonaws.services.cloudsearchv2.model.UpdateAvailabilityOptionsResult extends Object implements Serializable
  - Serialized Fields
    - availabilityOptions
```
AvailabilityOptionsStatus availabilityOptions
```
      The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.
- Class com.amazonaws.services.cloudsearchv2.model.UpdateScalingParametersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - scalingParameters
```
ScalingParameters scalingParameters
```
      The desired instance type and desired number of replicas of each index partition.
- Class com.amazonaws.services.cloudsearchv2.model.UpdateScalingParametersResult extends Object implements Serializable
  - Serialized Fields
    - scalingParameters
```
ScalingParametersStatus scalingParameters
```
      The status and configuration of a search domain's scaling parameters.
- Class com.amazonaws.services.cloudsearchv2.model.UpdateServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domainName
```
String domainName
```
      A string that represents the name of a 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).
      Constraints:
      Length: 3 - 28
      Pattern: [a-z][a-z0-9\-]+
    - accessPolicies
```
String accessPolicies
```
      The access rules you want to configure. These rules replace any existing rules.
- Class com.amazonaws.services.cloudsearchv2.model.UpdateServiceAccessPoliciesResult extends Object implements Serializable
  - Serialized Fields
    - accessPolicies
```
AccessPoliciesStatus accessPolicies
```
      The access rules configured for the domain.
Package com.amazonaws.services.cloudtrail.model
- Class com.amazonaws.services.cloudtrail.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceId
```
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.
    - tagsList
```
com.amazonaws.internal.SdkInternalList<T> tagsList
```
      Contains a list of CloudTrail tags, up to a limit of 10.
- Class com.amazonaws.services.cloudtrail.model.AddTagsResult extends Object implements Serializable
- Class com.amazonaws.services.cloudtrail.model.CloudTrailARNInvalidException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.CloudWatchLogsDeliveryUnavailableException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.CreateTrailRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Specifies the name of the trail. The name must meet the following requirements:
      
      Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
      
      Start with a letter or number, and end with a letter or number
      
      Be between 3 and 128 characters
      
      Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
      
      Not be in IP address format (for example, 192.168.5.4)
    - s3BucketName
```
String s3BucketName
```
      Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    - s3KeyPrefix
```
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.
    - snsTopicName
```
String snsTopicName
```
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
    - includeGlobalServiceEvents
```
Boolean includeGlobalServiceEvents
```
      Specifies whether the trail is publishing events from global services such as IAM to the log files.
    - isMultiRegionTrail
```
Boolean isMultiRegionTrail
```
      Specifies whether the trail is created in the current region or in all regions. The default is false.
    - enableLogFileValidation
```
Boolean enableLogFileValidation
```
      Specifies whether log file integrity validation is enabled. The default is false.
      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
    - cloudWatchLogsLogGroupArn
```
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.
    - cloudWatchLogsRoleArn
```
String cloudWatchLogsRoleArn
```
      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
    - kmsKeyId
```
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:
      
      alias/MyAliasName
      
      arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
      
      arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012
      
      12345678-1234-1234-1234-123456789012
- Class com.amazonaws.services.cloudtrail.model.CreateTrailResult extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Specifies the name of the trail.
    - s3BucketName
```
String s3BucketName
```
      Specifies the name of the Amazon S3 bucket designated for publishing log files.
    - s3KeyPrefix
```
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.
    - snsTopicName
```
String snsTopicName
```
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
    - includeGlobalServiceEvents
```
Boolean includeGlobalServiceEvents
```
      Specifies whether the trail is publishing events from global services such as IAM to the log files.
    - isMultiRegionTrail
```
Boolean isMultiRegionTrail
```
      Specifies whether the trail exists in one region or in all regions.
    - trailARN
```
String trailARN
```
      Specifies the ARN of the trail that was created.
    - logFileValidationEnabled
```
Boolean logFileValidationEnabled
```
      Specifies whether log file integrity validation is enabled.
    - cloudWatchLogsLogGroupArn
```
String cloudWatchLogsLogGroupArn
```
      Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
    - cloudWatchLogsRoleArn
```
String cloudWatchLogsRoleArn
```
      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
    - kmsKeyId
```
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-123456789012
- Class com.amazonaws.services.cloudtrail.model.DeleteTrailRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String 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.
- Class com.amazonaws.services.cloudtrail.model.DeleteTrailResult extends Object implements Serializable
- Class com.amazonaws.services.cloudtrail.model.DescribeTrailsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - trailNameList
```
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.
      
      If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current region is returned.
      
      If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.
      
      If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.
    - includeShadowTrails
```
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.
- Class com.amazonaws.services.cloudtrail.model.DescribeTrailsResult extends Object implements Serializable
  - Serialized Fields
    - trailList
```
com.amazonaws.internal.SdkInternalList<T> trailList
```
      The list of trail objects.
- Class com.amazonaws.services.cloudtrail.model.Event extends Object implements Serializable
  - Serialized Fields
    - eventId
```
String eventId
```
      The CloudTrail ID of the event returned.
    - eventName
```
String eventName
```
      The name of the event returned.
    - eventTime
```
Date eventTime
```
      The date and time of the event returned.
    - username
```
String username
```
      A user name or role name of the requester that called the API in the event returned.
    - resources
```
com.amazonaws.internal.SdkInternalList<T> resources
```
      A list of resources referenced by the event returned.
    - cloudTrailEvent
```
String cloudTrailEvent
```
      A JSON string that contains a representation of the event returned.
- Class com.amazonaws.services.cloudtrail.model.GetTrailStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
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.
- Class com.amazonaws.services.cloudtrail.model.GetTrailStatusResult extends Object implements Serializable
  - Serialized Fields
    - isLogging
```
Boolean isLogging
```
      Whether the CloudTrail is currently logging AWS API calls.
    - latestDeliveryError
```
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.
      This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.
    - latestNotificationError
```
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.
    - latestDeliveryTime
```
Date latestDeliveryTime
```
      Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.
    - latestNotificationTime
```
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.
    - startLoggingTime
```
Date startLoggingTime
```
      Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.
    - stopLoggingTime
```
Date stopLoggingTime
```
      Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.
    - latestCloudWatchLogsDeliveryError
```
String latestCloudWatchLogsDeliveryError
```
      Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.
    - latestCloudWatchLogsDeliveryTime
```
Date latestCloudWatchLogsDeliveryTime
```
      Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.
    - latestDigestDeliveryTime
```
Date latestDigestDeliveryTime
```
      Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.
    - latestDigestDeliveryError
```
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.
      This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call UpdateTrail to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.
    - latestDeliveryAttemptTime
```
String latestDeliveryAttemptTime
```
      This field is deprecated.
    - latestNotificationAttemptTime
```
String latestNotificationAttemptTime
```
      This field is deprecated.
    - latestNotificationAttemptSucceeded
```
String latestNotificationAttemptSucceeded
```
      This field is deprecated.
    - latestDeliveryAttemptSucceeded
```
String latestDeliveryAttemptSucceeded
```
      This field is deprecated.
    - timeLoggingStarted
```
String timeLoggingStarted
```
      This field is deprecated.
    - timeLoggingStopped
```
String timeLoggingStopped
```
      This field is deprecated.
- Class com.amazonaws.services.cloudtrail.model.InsufficientEncryptionPolicyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InsufficientS3BucketPolicyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InsufficientSnsTopicPolicyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidCloudWatchLogsLogGroupArnException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidCloudWatchLogsRoleArnException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidHomeRegionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidKmsKeyIdException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidLookupAttributesException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidMaxResultsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidParameterCombinationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidS3BucketNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidS3PrefixException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidSnsTopicNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidTagParameterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidTimeRangeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.InvalidTrailNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.KmsKeyDisabledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.KmsKeyNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.ListPublicKeysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - startTime
```
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.
    - endTime
```
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.
    - nextToken
```
String nextToken
```
      Reserved for future use.
- Class com.amazonaws.services.cloudtrail.model.ListPublicKeysResult extends Object implements Serializable
  - Serialized Fields
    - publicKeyList
```
com.amazonaws.internal.SdkInternalList<T> publicKeyList
```
      Contains an array of PublicKey objects.
      The returned public keys may have validity time ranges that overlap.
    - nextToken
```
String nextToken
```
      Reserved for future use.
- Class com.amazonaws.services.cloudtrail.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceIdList
```
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.
    - nextToken
```
String nextToken
```
      Reserved for future use.
- Class com.amazonaws.services.cloudtrail.model.ListTagsResult extends Object implements Serializable
  - Serialized Fields
    - resourceTagList
```
com.amazonaws.internal.SdkInternalList<T> resourceTagList
```
    - nextToken
```
String nextToken
```
      Reserved for future use.
- Class com.amazonaws.services.cloudtrail.model.LookupAttribute extends Object implements Serializable
  - Serialized Fields
    - attributeKey
```
String attributeKey
```
      Specifies an attribute on which to filter the events returned.
    - attributeValue
```
String attributeValue
```
      Specifies a value for the specified AttributeKey.
- Class com.amazonaws.services.cloudtrail.model.LookupEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - lookupAttributes
```
com.amazonaws.internal.SdkInternalList<T> lookupAttributes
```
      Contains a list of lookup attributes. Currently the list can contain only one item.
    - startTime
```
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.
    - endTime
```
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.
    - maxResults
```
Integer maxResults
```
      The number of events to return. Possible values are 1 through 50. The default is 10.
    - nextToken
```
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.
- Class com.amazonaws.services.cloudtrail.model.LookupEventsResult extends Object implements Serializable
  - Serialized Fields
    - events
```
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.
    - nextToken
```
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.
- Class com.amazonaws.services.cloudtrail.model.MaximumNumberOfTrailsExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.OperationNotPermittedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.PublicKey extends Object implements Serializable
  - Serialized Fields
    - value
```
ByteBuffer value
```
      The DER encoded public key value in PKCS#1 format.
    - validityStartTime
```
Date validityStartTime
```
      The starting time of validity of the public key.
    - validityEndTime
```
Date validityEndTime
```
      The ending time of validity of the public key.
    - fingerprint
```
String fingerprint
```
      The fingerprint of the public key.
- Class com.amazonaws.services.cloudtrail.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceId
```
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.
    - tagsList
```
com.amazonaws.internal.SdkInternalList<T> tagsList
```
      Specifies a list of tags to be removed.
- Class com.amazonaws.services.cloudtrail.model.RemoveTagsResult extends Object implements Serializable
- Class com.amazonaws.services.cloudtrail.model.Resource extends Object implements Serializable
  - Serialized Fields
    - resourceType
```
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.
    - resourceName
```
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.
- Class com.amazonaws.services.cloudtrail.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.ResourceTag extends Object implements Serializable
  - Serialized Fields
    - resourceId
```
String resourceId
```
      Specifies the ARN of the resource.
    - tagsList
```
com.amazonaws.internal.SdkInternalList<T> tagsList
```
- Class com.amazonaws.services.cloudtrail.model.ResourceTypeNotSupportedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.S3BucketDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.StartLoggingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
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.
- Class com.amazonaws.services.cloudtrail.model.StartLoggingResult extends Object implements Serializable
- Class com.amazonaws.services.cloudtrail.model.StopLoggingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
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.
- Class com.amazonaws.services.cloudtrail.model.StopLoggingResult extends Object implements Serializable
- Class com.amazonaws.services.cloudtrail.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.
    - value
```
String value
```
      The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
- Class com.amazonaws.services.cloudtrail.model.TagsLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.Trail extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
    - s3BucketName
```
String s3BucketName
```
      Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
    - s3KeyPrefix
```
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.
    - snsTopicName
```
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.
    - includeGlobalServiceEvents
```
Boolean includeGlobalServiceEvents
```
      Set to True to include AWS API calls from AWS global services such as IAM. Otherwise, False.
    - isMultiRegionTrail
```
Boolean isMultiRegionTrail
```
      Specifies whether the trail belongs only to one region or exists in all regions.
    - homeRegion
```
String homeRegion
```
      The region in which the trail was created.
    - trailARN
```
String trailARN
```
      The Amazon Resource Name of the trail. The TrailARN format is arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
    - logFileValidationEnabled
```
Boolean logFileValidationEnabled
```
      Specifies whether log file validation is enabled.
    - cloudWatchLogsLogGroupArn
```
String cloudWatchLogsLogGroupArn
```
      Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
    - cloudWatchLogsRoleArn
```
String cloudWatchLogsRoleArn
```
      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
    - kmsKeyId
```
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-123456789012
- Class com.amazonaws.services.cloudtrail.model.TrailAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.TrailNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.TrailNotProvidedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.UnsupportedOperationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudtrail.model.UpdateTrailRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Specifies the name of the trail or trail ARN. If Name is a trail name, the string must meet the following requirements:
      
      Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
      
      Start with a letter or number, and end with a letter or number
      
      Be between 3 and 128 characters
      
      Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are invalid.
      
      Not be in IP address format (for example, 192.168.5.4)
      
      If Name is a trail ARN, it must be in the format arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail.
    - s3BucketName
```
String s3BucketName
```
      Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
    - s3KeyPrefix
```
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.
    - snsTopicName
```
String snsTopicName
```
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
    - includeGlobalServiceEvents
```
Boolean includeGlobalServiceEvents
```
      Specifies whether the trail is publishing events from global services such as IAM to the log files.
    - isMultiRegionTrail
```
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.
    - enableLogFileValidation
```
Boolean enableLogFileValidation
```
      Specifies whether log file validation is enabled. The default is false.
      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.
    - cloudWatchLogsLogGroupArn
```
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.
    - cloudWatchLogsRoleArn
```
String cloudWatchLogsRoleArn
```
      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
    - kmsKeyId
```
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:
      
      alias/MyAliasName
      
      arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
      
      arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234- 123456789012
      
      12345678-1234-1234-1234-123456789012
- Class com.amazonaws.services.cloudtrail.model.UpdateTrailResult extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      Specifies the name of the trail.
    - s3BucketName
```
String s3BucketName
```
      Specifies the name of the Amazon S3 bucket designated for publishing log files.
    - s3KeyPrefix
```
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.
    - snsTopicName
```
String snsTopicName
```
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
    - includeGlobalServiceEvents
```
Boolean includeGlobalServiceEvents
```
      Specifies whether the trail is publishing events from global services such as IAM to the log files.
    - isMultiRegionTrail
```
Boolean isMultiRegionTrail
```
      Specifies whether the trail exists in one region or in all regions.
    - trailARN
```
String trailARN
```
      Specifies the ARN of the trail that was updated.
    - logFileValidationEnabled
```
Boolean logFileValidationEnabled
```
      Specifies whether log file integrity validation is enabled.
    - cloudWatchLogsLogGroupArn
```
String cloudWatchLogsLogGroupArn
```
      Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
    - cloudWatchLogsRoleArn
```
String cloudWatchLogsRoleArn
```
      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
    - kmsKeyId
```
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-123456789012
Package com.amazonaws.services.cloudwatch.model
- Class com.amazonaws.services.cloudwatch.model.AlarmHistoryItem extends Object implements Serializable
  - Serialized Fields
    - alarmName
```
String alarmName
```
      The descriptive name for the alarm.
    - timestamp
```
Date timestamp
```
      The time stamp for the alarm history item.
    - historyItemType
```
String historyItemType
```
      The type of alarm history item.
    - historySummary
```
String historySummary
```
      A human-readable summary of the alarm history.
    - historyData
```
String historyData
```
      Machine-readable data about the alarm in JSON format.
- Class com.amazonaws.services.cloudwatch.model.Datapoint extends Object implements Serializable
  - Serialized Fields
    - timestamp
```
Date timestamp
```
      The time stamp used for the datapoint.
    - sampleCount
```
Double sampleCount
```
      The number of metric values that contributed to the aggregate value of this datapoint.
    - average
```
Double average
```
      The average of metric values that correspond to the datapoint.
    - sum
```
Double sum
```
      The sum of metric values used for the datapoint.
    - minimum
```
Double minimum
```
      The minimum metric value used for the datapoint.
    - maximum
```
Double maximum
```
      The maximum of the metric value used for the datapoint.
    - unit
```
String unit
```
      The standard unit used for the datapoint.
- Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - alarmNames
```
com.amazonaws.internal.SdkInternalList<T> alarmNames
```
      A list of alarms to be deleted.
- Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - alarmName
```
String alarmName
```
      The name of the alarm.
    - historyItemType
```
String historyItemType
```
      The type of alarm histories to retrieve.
    - startDate
```
Date startDate
```
      The starting date to retrieve alarm history.
    - endDate
```
Date endDate
```
      The ending date to retrieve alarm history.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of alarm history records to retrieve.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to indicate that there is more data available.
- Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryResult extends Object implements Serializable
  - Serialized Fields
    - alarmHistoryItems
```
com.amazonaws.internal.SdkInternalList<T> alarmHistoryItems
```
      A list of alarm histories in JSON format.
    - nextToken
```
String nextToken
```
      A string that marks the start of the next batch of returned results.
- Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - metricName
```
String metricName
```
      The name of the metric.
    - namespace
```
String namespace
```
      The namespace of the metric.
    - statistic
```
String statistic
```
      The statistic for the metric.
    - dimensions
```
com.amazonaws.internal.SdkInternalList<T> dimensions
```
      The list of dimensions associated with the metric. If the metric has any associated dimensions, you must specify them in order for the DescribeAlarmsForMetric to succeed.
    - period
```
Integer period
```
      The period in seconds over which the statistic is applied.
    - unit
```
String unit
```
      The unit for the metric.
- Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricResult extends Object implements Serializable
  - Serialized Fields
    - metricAlarms
```
com.amazonaws.internal.SdkInternalList<T> metricAlarms
```
      A list of information for each alarm with the specified metric.
- Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - alarmNames
```
com.amazonaws.internal.SdkInternalList<T> alarmNames
```
      A list of alarm names to retrieve information for.
    - alarmNamePrefix
```
String alarmNamePrefix
```
      The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.
    - stateValue
```
String stateValue
```
      The state value to be used in matching alarms.
    - actionPrefix
```
String actionPrefix
```
      The action name prefix.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of alarm descriptions to retrieve.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to indicate that there is more data available.
- Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsResult extends Object implements Serializable
  - Serialized Fields
    - metricAlarms
```
com.amazonaws.internal.SdkInternalList<T> metricAlarms
```
      A list of information for the specified alarms.
    - nextToken
```
String nextToken
```
      A string that marks the start of the next batch of returned results.
- Class com.amazonaws.services.cloudwatch.model.Dimension extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the dimension.
    - value
```
String value
```
      The value representing the dimension measurement
- Class com.amazonaws.services.cloudwatch.model.DimensionFilter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The dimension name to be matched.
    - value
```
String value
```
      The value of the dimension to be matched.
      Specifying a Name without specifying a Value returns all values associated with that Name.
- Class com.amazonaws.services.cloudwatch.model.DisableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - alarmNames
```
com.amazonaws.internal.SdkInternalList<T> alarmNames
```
      The names of the alarms to disable actions for.
- Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - alarmNames
```
com.amazonaws.internal.SdkInternalList<T> alarmNames
```
      The names of the alarms to enable actions for.
- Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namespace
```
String namespace
```
      The namespace of the metric, with or without spaces.
    - metricName
```
String metricName
```
      The name of the metric, with or without spaces.
    - dimensions
```
com.amazonaws.internal.SdkInternalList<T> dimensions
```
      A list of dimensions describing qualities of the metric.
    - startTime
```
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. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
      The specified start time is rounded down to the nearest value. Datapoints are returned for start times up to two weeks in the past. Specified start times that are more than two weeks in the past will not return datapoints for metrics that are older than two weeks.
      Data that is timestamped 24 hours or more in the past may take in excess of 48 hours to become available from submission time using GetMetricStatistics.
    - endTime
```
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. The time stamp must be in ISO 8601 UTC format (e.g., 2014-09-03T23:00:00Z).
    - period
```
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.
    - statistics
```
com.amazonaws.internal.SdkInternalList<T> statistics
```
      The metric statistics to return. For information about specific statistics returned by GetMetricStatistics, see Statistics in the Amazon CloudWatch Developer Guide.
    - unit
```
String unit
```
      The unit for the metric.
- Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsResult extends Object implements Serializable
  - Serialized Fields
    - label
```
String label
```
      A label describing the specified metric.
    - datapoints
```
com.amazonaws.internal.SdkInternalList<T> datapoints
```
      The datapoints for the specified metric.
- Class com.amazonaws.services.cloudwatch.model.InternalServiceException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.InvalidFormatException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.InvalidNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.InvalidParameterCombinationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.InvalidParameterValueException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.ListMetricsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namespace
```
String namespace
```
      The namespace to filter against.
    - metricName
```
String metricName
```
      The name of the metric to filter against.
    - dimensions
```
com.amazonaws.internal.SdkInternalList<T> dimensions
```
      A list of dimensions to filter against.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to indicate that there is more data available.
- Class com.amazonaws.services.cloudwatch.model.ListMetricsResult extends Object implements Serializable
  - Serialized Fields
    - metrics
```
com.amazonaws.internal.SdkInternalList<T> metrics
```
      A list of metrics used to generate statistics for an AWS account.
    - nextToken
```
String nextToken
```
      A string that marks the start of the next batch of returned results.
- Class com.amazonaws.services.cloudwatch.model.Metric extends Object implements Serializable
  - Serialized Fields
    - namespace
```
String namespace
```
      The namespace of the metric.
    - metricName
```
String metricName
```
      The name of the metric.
    - dimensions
```
com.amazonaws.internal.SdkInternalList<T> dimensions
```
      A list of dimensions associated with the metric.
- Class com.amazonaws.services.cloudwatch.model.MetricAlarm extends Object implements Serializable
  - Serialized Fields
    - alarmName
```
String alarmName
```
      The name of the alarm.
    - alarmArn
```
String alarmArn
```
      The Amazon Resource Name (ARN) of the alarm.
    - alarmDescription
```
String alarmDescription
```
      The description for the alarm.
    - alarmConfigurationUpdatedTimestamp
```
Date alarmConfigurationUpdatedTimestamp
```
      The time stamp of the last update to the alarm configuration.
    - actionsEnabled
```
Boolean actionsEnabled
```
      Indicates whether actions should be executed during any changes to the alarm's state.
    - oKActions
```
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 Name (ARN).
    - alarmActions
```
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 Name (ARN).
    - insufficientDataActions
```
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 Name (ARN).
      The current WSDL lists this attribute as UnknownActions.
    - stateValue
```
String stateValue
```
      The state value for the alarm.
    - stateReason
```
String stateReason
```
      A human-readable explanation for the alarm's state.
    - stateReasonData
```
String stateReasonData
```
      An explanation for the alarm's state in machine-readable JSON format
    - stateUpdatedTimestamp
```
Date stateUpdatedTimestamp
```
      The time stamp of the last update to the alarm's state.
    - metricName
```
String metricName
```
      The name of the alarm's metric.
    - namespace
```
String namespace
```
      The namespace of alarm's associated metric.
    - statistic
```
String statistic
```
      The statistic to apply to the alarm's associated metric.
    - dimensions
```
com.amazonaws.internal.SdkInternalList<T> dimensions
```
      The list of dimensions associated with the alarm's associated metric.
    - period
```
Integer period
```
      The period in seconds over which the statistic is applied.
    - unit
```
String unit
```
      The unit of the alarm's associated metric.
    - evaluationPeriods
```
Integer evaluationPeriods
```
      The number of periods over which data is compared to the specified threshold.
    - threshold
```
Double threshold
```
      The value against which the specified statistic is compared.
    - comparisonOperator
```
String comparisonOperator
```
      The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
- Class com.amazonaws.services.cloudwatch.model.MetricDatum extends Object implements Serializable
  - Serialized Fields
    - metricName
```
String metricName
```
      The name of the metric.
    - dimensions
```
com.amazonaws.internal.SdkInternalList<T> dimensions
```
      A list of dimensions associated with the metric. Note, when using the Dimensions value in a query, you need to append .member.N to it (e.g., Dimensions.member.N).
    - timestamp
```
Date timestamp
```
      The time stamp used for the metric in ISO 8601 Universal Coordinated Time (UTC) format. If not specified, the default value is set to the time the metric data was received.
    - value
```
Double value
```
      The value for the metric.
      Although the Value parameter accepts numbers of type Double, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.
    - statisticValues
```
StatisticSet statisticValues
```
      A set of statistical values describing the metric.
    - unit
```
String unit
```
      The unit of the metric.
- Class com.amazonaws.services.cloudwatch.model.MissingRequiredParameterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - alarmName
```
String alarmName
```
      The descriptive name for the alarm. This name must be unique within the user's AWS account
    - alarmDescription
```
String alarmDescription
```
      The description for the alarm.
    - actionsEnabled
```
Boolean actionsEnabled
```
      Indicates whether or not actions should be executed during any changes to the alarm's state.
    - oKActions
```
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 Name (ARN).
      
      Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
      
      Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0
      
      Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
    - alarmActions
```
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 Name (ARN).
      
      Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
      
      Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0
      
      Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
    - insufficientDataActions
```
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 Name (ARN).
      
      Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):ec2:recover
      
      Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer- account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east -1:{customer-account}:action/actions/AWS_EC2.InstanceId .Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions /AWS_EC2.InstanceId.Reboot/1.0
      
      Note: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
    - metricName
```
String metricName
```
      The name for the alarm's associated metric.
    - namespace
```
String namespace
```
      The namespace for the alarm's associated metric.
    - statistic
```
String statistic
```
      The statistic to apply to the alarm's associated metric.
    - dimensions
```
com.amazonaws.internal.SdkInternalList<T> dimensions
```
      The dimensions for the alarm's associated metric.
    - period
```
Integer period
```
      The period in seconds over which the specified statistic is applied.
    - unit
```
String unit
```
      The statistic's unit of measure. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
      
      Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
    - evaluationPeriods
```
Integer evaluationPeriods
```
      The number of periods over which data is compared to the specified threshold.
    - threshold
```
Double threshold
```
      The value against which the specified statistic is compared.
    - comparisonOperator
```
String comparisonOperator
```
      The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand.
- Class com.amazonaws.services.cloudwatch.model.PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namespace
```
String namespace
```
      The namespace for the metric data.
      You cannot specify a namespace that begins with "AWS/". Namespaces that begin with "AWS/" are reserved for other Amazon Web Services products that send metrics to Amazon CloudWatch.
    - metricData
```
com.amazonaws.internal.SdkInternalList<T> metricData
```
      A list of data describing the metric.
- Class com.amazonaws.services.cloudwatch.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - alarmName
```
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.
    - stateValue
```
String stateValue
```
      The value of the state.
    - stateReason
```
String stateReason
```
      The reason that this alarm is set to this specific state (in human-readable text format)
    - stateReasonData
```
String stateReasonData
```
      The reason that this alarm is set to this specific state (in machine-readable JSON format)
- Class com.amazonaws.services.cloudwatch.model.StatisticSet extends Object implements Serializable
  - Serialized Fields
    - sampleCount
```
Double sampleCount
```
      The number of samples used for the statistic set.
    - sum
```
Double sum
```
      The sum of values for the sample set.
    - minimum
```
Double minimum
```
      The minimum value of the sample set.
    - maximum
```
Double maximum
```
      The maximum value of the sample set.
Package com.amazonaws.services.cloudwatchevents.model
- Class com.amazonaws.services.cloudwatchevents.model.ConcurrentModificationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule to be deleted.
- Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule you want to describe details for.
- Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleResult extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The rule's name.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) associated with the rule.
    - eventPattern
```
String eventPattern
```
      The event pattern.
    - scheduleExpression
```
String scheduleExpression
```
      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
    - state
```
String state
```
      Specifies whether the rule is enabled or disabled.
    - description
```
String description
```
      The rule's description.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the IAM role associated with the rule.
- Class com.amazonaws.services.cloudwatchevents.model.DisableRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule you want to disable.
- Class com.amazonaws.services.cloudwatchevents.model.EnableRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule that you want to enable.
- Class com.amazonaws.services.cloudwatchevents.model.InternalException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.InvalidEventPatternException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - targetArn
```
String targetArn
```
      The Amazon Resource Name (ARN) of the target resource that you want to list the rules for.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to indicate that there is more data available.
    - limit
```
Integer limit
```
      The maximum number of results to return.
- Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetResult extends Object implements Serializable
  - Serialized Fields
    - ruleNames
```
List<E> ruleNames
```
      List of rules names that can invoke the given target.
    - nextToken
```
String nextToken
```
      Indicates that there are additional results to retrieve.
- Class com.amazonaws.services.cloudwatchevents.model.ListRulesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namePrefix
```
String namePrefix
```
      The prefix matching the rule name.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to indicate that there is more data available.
    - limit
```
Integer limit
```
      The maximum number of results to return.
- Class com.amazonaws.services.cloudwatchevents.model.ListRulesResult extends Object implements Serializable
  - Serialized Fields
    - rules
```
List<E> rules
```
      List of rules matching the specified criteria.
    - nextToken
```
String nextToken
```
      Indicates that there are additional results to retrieve.
- Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rule
```
String rule
```
      The name of the rule whose targets you want to list.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to indicate that there is more data available.
    - limit
```
Integer limit
```
      The maximum number of results to return.
- Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleResult extends Object implements Serializable
  - Serialized Fields
    - targets
```
List<E> targets
```
      Lists the targets assigned to the rule.
    - nextToken
```
String nextToken
```
      Indicates that there are additional results to retrieve.
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - entries
```
List<E> entries
```
      The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsRequestEntry extends Object implements Serializable
  - Serialized Fields
    - time
```
Date time
```
      Timestamp of event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call will be used.
    - source
```
String source
```
      The source of the event.
    - resources
```
List<E> resources
```
      AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    - detailType
```
String detailType
```
      Free-form string used to decide what fields to expect in the event detail.
    - 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.
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsResult extends Object implements Serializable
  - Serialized Fields
    - failedEntryCount
```
Integer failedEntryCount
```
      The number of failed entries.
    - 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.
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsResultEntry extends Object implements Serializable
  - Serialized Fields
    - eventId
```
String eventId
```
      The ID of the event submitted to Amazon CloudWatch Events.
    - errorCode
```
String errorCode
```
      The error code representing why the event submission failed on this entry.
    - errorMessage
```
String errorMessage
```
      The error message explaining why the event submission failed on this entry.
- Class com.amazonaws.services.cloudwatchevents.model.PutRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule that you are creating or updating.
    - scheduleExpression
```
String scheduleExpression
```
      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
    - eventPattern
```
String eventPattern
```
      The event pattern.
    - state
```
String state
```
      Indicates whether the rule is enabled or disabled.
    - description
```
String description
```
      A description of the rule.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the IAM role associated with the rule.
- Class com.amazonaws.services.cloudwatchevents.model.PutRuleResult extends Object implements Serializable
  - Serialized Fields
    - ruleArn
```
String ruleArn
```
      The Amazon Resource Name (ARN) that identifies the rule.
- Class com.amazonaws.services.cloudwatchevents.model.PutTargetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rule
```
String rule
```
      The name of the rule you want to add targets to.
    - targets
```
List<E> targets
```
      List of targets you want to update or add to the rule.
- Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResult extends Object implements Serializable
  - Serialized Fields
    - failedEntryCount
```
Integer failedEntryCount
```
      The number of failed entries.
    - failedEntries
```
List<E> failedEntries
```
      An array of failed target entries.
- Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResultEntry extends Object implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The ID of the target submitted to Amazon CloudWatch Events.
    - errorCode
```
String errorCode
```
      The error code representing why the target submission failed on this entry.
    - errorMessage
```
String errorMessage
```
      The error message explaining why the target submission failed on this entry.
- Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rule
```
String rule
```
      The name of the rule you want to remove targets from.
    - ids
```
List<E> ids
```
      The list of target IDs to remove from the rule.
- Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResult extends Object implements Serializable
  - Serialized Fields
    - failedEntryCount
```
Integer failedEntryCount
```
      The number of failed entries.
    - failedEntries
```
List<E> failedEntries
```
      An array of failed target entries.
- Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResultEntry extends Object implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The ID of the target requested to be removed by Amazon CloudWatch Events.
    - errorCode
```
String errorCode
```
      The error code representing why the target removal failed on this entry.
    - errorMessage
```
String errorMessage
```
      The error message explaining why the target removal failed on this entry.
- Class com.amazonaws.services.cloudwatchevents.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.Rule extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The rule's name.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the rule.
    - eventPattern
```
String eventPattern
```
      The event pattern of the rule.
    - state
```
String state
```
      The rule's state.
    - description
```
String description
```
      The description of the rule.
    - scheduleExpression
```
String scheduleExpression
```
      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) associated with the role that is used for target invocation.
- Class com.amazonaws.services.cloudwatchevents.model.Target extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique target assignment ID.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) associated of the target.
    - input
```
String input
```
      Valid JSON text passed to the target. For more information about JSON text, see The JavaScript Object Notation (JSON) Data Interchange Format.
    - inputPath
```
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.
- Class com.amazonaws.services.cloudwatchevents.model.TestEventPatternRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - eventPattern
```
String eventPattern
```
      The event pattern you want to test.
    - event
```
String event
```
      The event in the JSON format to test against the event pattern.
- Class com.amazonaws.services.cloudwatchevents.model.TestEventPatternResult extends Object implements Serializable
  - Serialized Fields
    - result
```
Boolean result
```
      Indicates whether the event matches the event pattern.
Package com.amazonaws.services.codecommit.model
- Class com.amazonaws.services.codecommit.model.BatchGetRepositoriesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryNames
```
List<E> repositoryNames
```
      The names of the repositories to get information about.
- Class com.amazonaws.services.codecommit.model.BatchGetRepositoriesResult extends Object implements Serializable
  - Serialized Fields
    - repositories
```
List<E> repositories
```
      A list of repositories returned by the batch get repositories operation.
    - repositoriesNotFound
```
List<E> repositoriesNotFound
```
      Returns a list of repository names for which information could not be found.
- Class com.amazonaws.services.codecommit.model.BranchDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.BranchInfo extends Object implements Serializable
  - Serialized Fields
    - branchName
```
String branchName
```
      The name of the branch.
    - commitId
```
String commitId
```
      The ID of the last commit made to the branch.
- Class com.amazonaws.services.codecommit.model.BranchNameExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.BranchNameRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.Commit extends Object implements Serializable
  - Serialized Fields
    - treeId
```
String treeId
```
      Tree information for the specified commit.
    - parents
```
List<E> parents
```
      The parent list for the specified commit.
    - message
```
String message
```
      The message associated with the specified commit.
    - author
```
UserInfo author
```
      Information about the author of the specified commit.
    - committer
```
UserInfo committer
```
      Information about the person who committed the specified commit, also known as the committer. For more information about the difference between an author and a committer in Git, see Viewing the Commit History in Pro Git by Scott Chacon and Ben Straub.
    - additionalData
```
String additionalData
```
      Any additional data associated with the specified commit.
- Class com.amazonaws.services.codecommit.model.CommitDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.CommitIdDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.CommitIdRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.CreateBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository in which you want to create the new branch.
    - branchName
```
String branchName
```
      The name of the new branch to create.
    - commitId
```
String commitId
```
      The ID of the commit to point the new branch to.
- Class com.amazonaws.services.codecommit.model.CreateRepositoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the new repository to be created.
      
      The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide. The suffix ".git" is prohibited.
    - repositoryDescription
```
String repositoryDescription
```
      A comment or description about the new repository.
      
      The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.
- Class com.amazonaws.services.codecommit.model.CreateRepositoryResult extends Object implements Serializable
  - Serialized Fields
    - repositoryMetadata
```
RepositoryMetadata repositoryMetadata
```
      Information about the newly created repository.
- Class com.amazonaws.services.codecommit.model.DeleteRepositoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository to delete.
- Class com.amazonaws.services.codecommit.model.DeleteRepositoryResult extends Object implements Serializable
  - Serialized Fields
    - repositoryId
```
String repositoryId
```
      The ID of the repository that was deleted.
- Class com.amazonaws.services.codecommit.model.EncryptionIntegrityChecksFailedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.EncryptionKeyAccessDeniedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.EncryptionKeyDisabledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.EncryptionKeyNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.EncryptionKeyUnavailableException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.GetBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository that contains the branch for which you want to retrieve information.
    - branchName
```
String branchName
```
      The name of the branch for which you want to retrieve information.
- Class com.amazonaws.services.codecommit.model.GetBranchResult extends Object implements Serializable
  - Serialized Fields
    - branch
```
BranchInfo branch
```
      The name of the branch.
- Class com.amazonaws.services.codecommit.model.GetCommitRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository to which the commit was made.
    - commitId
```
String commitId
```
      The commit ID.
- Class com.amazonaws.services.codecommit.model.GetCommitResult extends Object implements Serializable
  - Serialized Fields
    - commit
```
Commit commit
```
      Information about the specified commit.
- Class com.amazonaws.services.codecommit.model.GetRepositoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository to get information about.
- Class com.amazonaws.services.codecommit.model.GetRepositoryResult extends Object implements Serializable
  - Serialized Fields
    - repositoryMetadata
```
RepositoryMetadata repositoryMetadata
```
      Information about the repository.
- Class com.amazonaws.services.codecommit.model.GetRepositoryTriggersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository for which the trigger is configured.
- Class com.amazonaws.services.codecommit.model.GetRepositoryTriggersResult extends Object implements Serializable
  - Serialized Fields
    - configurationId
```
String configurationId
```
      The system-generated unique ID for the trigger.
    - triggers
```
List<E> triggers
```
      The JSON block of configuration information for each trigger.
- Class com.amazonaws.services.codecommit.model.InvalidBranchNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidCommitIdException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidContinuationTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidOrderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryDescriptionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerBranchNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerCustomDataException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerDestinationArnException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerEventsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerRegionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.InvalidSortByException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.ListBranchesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository that contains the branches.
    - nextToken
```
String nextToken
```
      An enumeration token that allows the operation to batch the results.
- Class com.amazonaws.services.codecommit.model.ListBranchesResult extends Object implements Serializable
  - Serialized Fields
    - branches
```
List<E> branches
```
      The list of branch names.
    - nextToken
```
String nextToken
```
      An enumeration token that returns the batch of the results.
- Class com.amazonaws.services.codecommit.model.ListRepositoriesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
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.
    - sortBy
```
String sortBy
```
      The criteria used to sort the results of a list repositories operation.
    - order
```
String order
```
      The order in which to sort the results of a list repositories operation.
- Class com.amazonaws.services.codecommit.model.ListRepositoriesResult extends Object implements Serializable
  - Serialized Fields
    - repositories
```
List<E> repositories
```
      Lists the repositories called by the list repositories operation.
    - nextToken
```
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.
- Class com.amazonaws.services.codecommit.model.MaximumBranchesExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.MaximumRepositoryNamesExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.MaximumRepositoryTriggersExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.PutRepositoryTriggersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository where you want to create or update the trigger.
    - triggers
```
List<E> triggers
```
      The JSON block of configuration information for each trigger.
- Class com.amazonaws.services.codecommit.model.PutRepositoryTriggersResult extends Object implements Serializable
  - Serialized Fields
    - configurationId
```
String configurationId
```
      The system-generated unique ID for the create or update operation.
- Class com.amazonaws.services.codecommit.model.RepositoryDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryMetadata extends Object implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      The ID of the AWS account associated with the repository.
    - repositoryId
```
String repositoryId
```
      The ID of the repository.
    - repositoryName
```
String repositoryName
```
      The repository's name.
    - repositoryDescription
```
String repositoryDescription
```
      A comment or description about the repository.
    - defaultBranch
```
String defaultBranch
```
      The repository's default branch name.
    - lastModifiedDate
```
Date lastModifiedDate
```
      The date and time the repository was last modified, in timestamp format.
    - creationDate
```
Date creationDate
```
      The date and time the repository was created, in timestamp format.
    - cloneUrlHttp
```
String cloneUrlHttp
```
      The URL to use for cloning the repository over HTTPS.
    - cloneUrlSsh
```
String cloneUrlSsh
```
      The URL to use for cloning the repository over SSH.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the repository.
- Class com.amazonaws.services.codecommit.model.RepositoryNameExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryNameIdPair extends Object implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name associated with the repository.
    - repositoryId
```
String repositoryId
```
      The ID associated with the repository.
- Class com.amazonaws.services.codecommit.model.RepositoryNameRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryNamesRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryTrigger extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the trigger.
    - destinationArn
```
String destinationArn
```
      The ARN of the resource that is the target for a trigger. For example, the ARN of a topic in Amazon Simple Notification Service (SNS).
    - customData
```
String customData
```
      Any custom data associated with the trigger that will be included in the information sent to the target of the trigger.
    - branches
```
List<E> branches
```
      The branches that will be included in the trigger configuration. If no branches are specified, the trigger will apply to all branches.
    - events
```
List<E> events
```
      The repository events that will cause the trigger to run actions in another service, such as sending a notification through Amazon Simple Notification Service (SNS). If no events are specified, the trigger will run for all repository events.
- Class com.amazonaws.services.codecommit.model.RepositoryTriggerBranchNameListRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryTriggerDestinationArnRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryTriggerEventsListRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryTriggerExecutionFailure extends Object implements Serializable
  - Serialized Fields
    - trigger
```
String trigger
```
      The name of the trigger that did not run.
    - failureMessage
```
String failureMessage
```
      Additional message information about the trigger that did not run.
- Class com.amazonaws.services.codecommit.model.RepositoryTriggerNameRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.RepositoryTriggersListRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codecommit.model.TestRepositoryTriggersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository in which to test the triggers.
    - triggers
```
List<E> triggers
```
      The list of triggers to test.
- Class com.amazonaws.services.codecommit.model.TestRepositoryTriggersResult extends Object implements Serializable
  - Serialized Fields
    - successfulExecutions
```
List<E> successfulExecutions
```
      The list of triggers that were successfully tested. This list provides the names of the triggers that were successfully tested, separated by commas.
    - failedExecutions
```
List<E> failedExecutions
```
      The list of triggers that were not able to be tested. This list provides the names of the triggers that could not be tested, separated by commas.
- Class com.amazonaws.services.codecommit.model.UpdateDefaultBranchRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository to set or change the default branch for.
    - defaultBranchName
```
String defaultBranchName
```
      The name of the branch to set as the default.
- Class com.amazonaws.services.codecommit.model.UpdateRepositoryDescriptionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - repositoryName
```
String repositoryName
```
      The name of the repository to set or change the comment or description for.
    - repositoryDescription
```
String repositoryDescription
```
      The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.
- Class com.amazonaws.services.codecommit.model.UpdateRepositoryNameRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - oldName
```
String oldName
```
      The existing name of the repository.
    - newName
```
String newName
```
      The new name for the repository.
- Class com.amazonaws.services.codecommit.model.UserInfo extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the user who made the specified commit.
    - email
```
String email
```
      The email address associated with the user who made the commit, if any.
    - dateValue
```
String dateValue
```
      The date when the specified commit was pushed to the repository.
Package com.amazonaws.services.codedeploy.model
- Class com.amazonaws.services.codedeploy.model.AddTagsToOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      The tag key-value pairs to add to the on-premises instances.
      
      Keys and values are both required. Keys cannot be null or empty strings. Value-only tags are not allowed.
    - instanceNames
```
com.amazonaws.internal.SdkInternalList<T> instanceNames
```
      The names of the on-premises instances to which to add tags.
- Class com.amazonaws.services.codedeploy.model.ApplicationAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.ApplicationInfo extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      The application ID.
    - applicationName
```
String applicationName
```
      The application name.
    - createTime
```
Date createTime
```
      The time at which the application was created.
    - linkedToGitHub
```
Boolean linkedToGitHub
```
      True if the user has authenticated with GitHub for the specified application; otherwise, false.
- Class com.amazonaws.services.codedeploy.model.ApplicationLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.AutoScalingGroup extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The Auto Scaling group name.
    - hook
```
String hook
```
      An Auto Scaling lifecycle event hook name.
- Class com.amazonaws.services.codedeploy.model.BatchGetApplicationRevisionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application about which to get revision information.
    - revisions
```
com.amazonaws.internal.SdkInternalList<T> revisions
```
      Information to get about the application revisions, including type and location.
- Class com.amazonaws.services.codedeploy.model.BatchGetApplicationRevisionsResult extends Object implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of the application that corresponds to the revisions.
    - errorMessage
```
String errorMessage
```
      Information about errors that may have occurred during the API call.
    - revisions
```
com.amazonaws.internal.SdkInternalList<T> revisions
```
      Additional information about the revisions, including the type and location.
- Class com.amazonaws.services.codedeploy.model.BatchGetApplicationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationNames
```
com.amazonaws.internal.SdkInternalList<T> applicationNames
```
      A list of application names separated by spaces.
- Class com.amazonaws.services.codedeploy.model.BatchGetApplicationsResult extends Object implements Serializable
  - Serialized Fields
    - applicationsInfo
```
com.amazonaws.internal.SdkInternalList<T> applicationsInfo
```
      Information about the applications.
- Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - deploymentGroupNames
```
com.amazonaws.internal.SdkInternalList<T> deploymentGroupNames
```
      The deployment groups' names.
- Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentGroupsResult extends Object implements Serializable
  - Serialized Fields
    - deploymentGroupsInfo
```
com.amazonaws.internal.SdkInternalList<T> deploymentGroupsInfo
```
      Information about the deployment groups.
    - errorMessage
```
String errorMessage
```
      Information about errors that may have occurred during the API call.
- Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The unique ID of a deployment.
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      The unique IDs of instances in the deployment group.
- Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentInstancesResult extends Object implements Serializable
  - Serialized Fields
    - instancesSummary
```
com.amazonaws.internal.SdkInternalList<T> instancesSummary
```
      Information about the instance.
    - errorMessage
```
String errorMessage
```
      Information about errors that may have occurred during the API call.
- Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentIds
```
com.amazonaws.internal.SdkInternalList<T> deploymentIds
```
      A list of deployment IDs, separated by spaces.
- Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentsResult extends Object implements Serializable
  - Serialized Fields
    - deploymentsInfo
```
com.amazonaws.internal.SdkInternalList<T> deploymentsInfo
```
      Information about the deployments.
- Class com.amazonaws.services.codedeploy.model.BatchGetOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceNames
```
com.amazonaws.internal.SdkInternalList<T> instanceNames
```
      The names of the on-premises instances about which to get information.
- Class com.amazonaws.services.codedeploy.model.BatchGetOnPremisesInstancesResult extends Object implements Serializable
  - Serialized Fields
    - instanceInfos
```
com.amazonaws.internal.SdkInternalList<T> instanceInfos
```
      Information about the on-premises instances.
- Class com.amazonaws.services.codedeploy.model.BatchLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.BucketNameFilterRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of the application. This name must be unique with the applicable IAM user or AWS account.
- Class com.amazonaws.services.codedeploy.model.CreateApplicationResult extends Object implements Serializable
  - Serialized Fields
    - applicationId
```
String applicationId
```
      A unique application ID.
- Class com.amazonaws.services.codedeploy.model.CreateDeploymentConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentConfigName
```
String deploymentConfigName
```
      The name of the deployment configuration to create.
    - minimumHealthyHosts
```
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:
      
      HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
      
      FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.
      
      The value parameter takes an integer.
      
      For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.
- Class com.amazonaws.services.codedeploy.model.CreateDeploymentConfigResult extends Object implements Serializable
  - Serialized Fields
    - deploymentConfigId
```
String deploymentConfigId
```
      A unique deployment configuration ID.
- Class com.amazonaws.services.codedeploy.model.CreateDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - deploymentGroupName
```
String deploymentGroupName
```
      The name of a new deployment group for the specified application.
    - deploymentConfigName
```
String deploymentConfigName
```
      If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.
      
      CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.
      
      The predefined deployment configurations include the following:
      
      CodeDeployDefault.AllAtOnce attempts to deploy an application revision to as many instance as possible at once. The status of the overall deployment will be displayed as Succeeded if the application revision is deployed to one or more of the instances. The status of the overall deployment will be displayed as Failed if the application revision is not deployed to any of the instances. Using an example of nine instance, CodeDeployDefault.AllAtOnce will attempt to deploy to all nine instance at once. The overall deployment will succeed if deployment to even a single instance is successful; it will fail only if deployments to all nine instance fail.
      
      CodeDeployDefault.HalfAtATime deploys to up to half of the instances at a time (with fractions rounded down). The overall deployment succeeds if the application revision is deployed to at least half of the instances (with fractions rounded up); otherwise, the deployment fails. In the example of nine instances, it will deploy to up to four instance at a time. The overall deployment succeeds if deployment to five or more instances succeed; otherwise, the deployment fails. The deployment may be successfully deployed to some instances even if the overall deployment fails.
      
      CodeDeployDefault.OneAtATime deploys the application revision to only one instance at a time.
      
      For deployment groups that contain more than one instance:
      
      The overall deployment succeeds if the application revision is deployed to all of the instances. The exception to this rule is if deployment to the last instance fails, the overall deployment still succeeds. This is because AWS CodeDeploy allows only one instance at a time to be taken offline with the CodeDeployDefault.OneAtATime configuration.
      
      The overall deployment fails as soon as the application revision fails to be deployed to any but the last instance. The deployment may be successfully deployed to some instances even if the overall deployment fails.
      
      In an example using nine instance, it will deploy to one instance at a time. The overall deployment succeeds if deployment to the first eight instance is successful; the overall deployment fails if deployment to any of the first eight instance fails.
      
      For deployment groups that contain only one instance, the overall deployment is successful only if deployment to the single instance is successful
    - ec2TagFilters
```
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
```
      The Amazon EC2 tags on which to filter.
    - onPremisesInstanceTagFilters
```
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
```
      The on-premises instance tags on which to filter.
    - autoScalingGroups
```
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
```
      A list of associated Auto Scaling groups.
    - serviceRoleArn
```
String serviceRoleArn
```
      A service role ARN that allows AWS CodeDeploy to act on the user's behalf when interacting with AWS services.
    - triggerConfigurations
```
com.amazonaws.internal.SdkInternalList<T> triggerConfigurations
```
      Information about triggers to create when the deployment group is created.
- Class com.amazonaws.services.codedeploy.model.CreateDeploymentGroupResult extends Object implements Serializable
  - Serialized Fields
    - deploymentGroupId
```
String deploymentGroupId
```
      A unique deployment group ID.
- Class com.amazonaws.services.codedeploy.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - deploymentGroupName
```
String deploymentGroupName
```
      The name of the deployment group.
    - revision
```
RevisionLocation revision
```
      The type and location of the revision to deploy.
    - deploymentConfigName
```
String deploymentConfigName
```
      The name of a 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.
    - description
```
String description
```
      A comment about the deployment.
    - ignoreApplicationStopFailures
```
Boolean ignoreApplicationStopFailures
```
      If set to true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.
- Class com.amazonaws.services.codedeploy.model.CreateDeploymentResult extends Object implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      A unique deployment ID.
- Class com.amazonaws.services.codedeploy.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Class com.amazonaws.services.codedeploy.model.DeleteDeploymentConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentConfigName
```
String deploymentConfigName
```
      The name of a deployment configuration associated with the applicable IAM user or AWS account.
- Class com.amazonaws.services.codedeploy.model.DeleteDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - deploymentGroupName
```
String deploymentGroupName
```
      The name of an existing deployment group for the specified application.
- Class com.amazonaws.services.codedeploy.model.DeleteDeploymentGroupResult extends Object implements Serializable
  - Serialized Fields
    - hooksNotCleanedUp
```
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 group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
- Class com.amazonaws.services.codedeploy.model.DeploymentAlreadyCompletedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentConfigAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentConfigDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentConfigInfo extends Object implements Serializable
  - Serialized Fields
    - deploymentConfigId
```
String deploymentConfigId
```
      The deployment configuration ID.
    - deploymentConfigName
```
String deploymentConfigName
```
      The deployment configuration name.
    - minimumHealthyHosts
```
MinimumHealthyHosts minimumHealthyHosts
```
      Information about the number or percentage of minimum healthy instance.
    - createTime
```
Date createTime
```
      The time at which the deployment configuration was created.
- Class com.amazonaws.services.codedeploy.model.DeploymentConfigInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentConfigLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentConfigNameRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentGroupAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentGroupDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentGroupInfo extends Object implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The application name.
    - deploymentGroupId
```
String deploymentGroupId
```
      The deployment group ID.
    - deploymentGroupName
```
String deploymentGroupName
```
      The deployment group name.
    - deploymentConfigName
```
String deploymentConfigName
```
      The deployment configuration name.
    - ec2TagFilters
```
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
```
      The Amazon EC2 tags on which to filter.
    - onPremisesInstanceTagFilters
```
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
```
      The on-premises instance tags on which to filter.
    - autoScalingGroups
```
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups
```
      A list of associated Auto Scaling groups.
    - serviceRoleArn
```
String serviceRoleArn
```
      A service role ARN.
    - targetRevision
```
RevisionLocation targetRevision
```
      Information about the deployment group's target revision, including type and location.
    - triggerConfigurations
```
com.amazonaws.internal.SdkInternalList<T> triggerConfigurations
```
      A list of associated triggers.
- Class com.amazonaws.services.codedeploy.model.DeploymentGroupLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentInfo extends Object implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The application name.
    - deploymentGroupName
```
String deploymentGroupName
```
      The deployment group name.
    - deploymentConfigName
```
String deploymentConfigName
```
      The deployment configuration name.
    - deploymentId
```
String deploymentId
```
      The deployment ID.
    - revision
```
RevisionLocation revision
```
      Information about the location of stored application artifacts and the service from which to retrieve them.
    - status
```
String status
```
      The current state of the deployment as a whole.
    - errorInformation
```
ErrorInformation errorInformation
```
      Information about any error associated with this deployment.
    - createTime
```
Date createTime
```
      A timestamp indicating when the deployment was created.
    - startTime
```
Date startTime
```
      A timestamp indicating when the deployment was deployed to the deployment group.
      
      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 back-end servers that participate in the deployment process.
    - completeTime
```
Date completeTime
```
      A timestamp indicating when the deployment was complete.
    - deploymentOverview
```
DeploymentOverview deploymentOverview
```
      A summary of the deployment status of the instances in the deployment.
    - description
```
String description
```
      A comment about the deployment.
    - creator
```
String creator
```
      The means by which the deployment was created:
      
      user: A user created the deployment.
      
      autoscaling: Auto Scaling created the deployment.
    - ignoreApplicationStopFailures
```
Boolean ignoreApplicationStopFailures
```
      If true, then if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance will not be considered to have failed 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 an instance to fail, the deployment to that instance will stop, and the deployment to that instance will be considered to have failed.
- Class com.amazonaws.services.codedeploy.model.DeploymentLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentNotStartedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.DeploymentOverview extends Object implements Serializable
  - Serialized Fields
    - pending
```
Long pending
```
      The number of instances in the deployment in a pending state.
    - inProgress
```
Long inProgress
```
      The number of instances in which the deployment is in progress.
    - succeeded
```
Long succeeded
```
      The number of instances in the deployment to which revisions have been successfully deployed.
    - failed
```
Long failed
```
      The number of instances in the deployment in a failed state.
    - skipped
```
Long skipped
```
      The number of instances in the deployment in a skipped state.
- Class com.amazonaws.services.codedeploy.model.DeregisterOnPremisesInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceName
```
String instanceName
```
      The name of the on-premises instance to deregister.
- Class com.amazonaws.services.codedeploy.model.DescriptionTooLongException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.Diagnostics extends Object implements Serializable
  - Serialized Fields
    - errorCode
```
String errorCode
```
      The associated error code:
      
      Success: The specified script ran.
      
      ScriptMissing: The specified script was not found in the specified location.
      
      ScriptNotExecutable: The specified script is not a recognized executable file type.
      
      ScriptTimedOut: The specified script did not finish running in the specified time period.
      
      ScriptFailed: The specified script failed to run as expected.
      
      UnknownError: The specified script did not run for an unknown reason.
    - scriptName
```
String scriptName
```
      The name of the script.
    - message
```
String message
```
      The message associated with the error.
    - logTail
```
String logTail
```
      The last portion of the diagnostic log.
      
      If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.
- Class com.amazonaws.services.codedeploy.model.EC2TagFilter extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The tag filter key.
    - value
```
String value
```
      The tag filter value.
    - type
```
String type
```
      The tag filter type:
      
      KEY_ONLY: Key only.
      
      VALUE_ONLY: Value only.
      
      KEY_AND_VALUE: Key and value.
- Class com.amazonaws.services.codedeploy.model.ErrorInformation extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The error code:
      
      APPLICATION_MISSING: The application was missing. This error code will most likely be raised if the application is deleted after the deployment is created but before it is started.
      
      DEPLOYMENT_GROUP_MISSING: The deployment group was missing. This error code will most likely be raised if the deployment group is deleted after the deployment is created but before it is started.
      
      HEALTH_CONSTRAINTS: The deployment failed on too many instances to be successfully deployed within the instance health constraints specified.
      
      HEALTH_CONSTRAINTS_INVALID: The revision cannot be successfully deployed within the instance health constraints specified.
      
      IAM_ROLE_MISSING: The service role cannot be accessed.
      
      IAM_ROLE_PERMISSIONS: The service role does not have the correct permissions.
      
      INTERNAL_ERROR: There was an internal error.
      
      NO_EC2_SUBSCRIPTION: The calling account is not subscribed to the Amazon EC2 service.
      
      NO_INSTANCES: No instance were specified, or no instance can be found.
      
      OVER_MAX_INSTANCES: The maximum number of instance was exceeded.
      
      THROTTLED: The operation was throttled because the calling account exceeded the throttling limits of one or more AWS services.
      
      TIMEOUT: The deployment has timed out.
      
      REVISION_MISSING: The revision ID was missing. This error code will most likely be raised if the revision is deleted after the deployment is created but before it is started.
    - message
```
String message
```
      An accompanying error message.
- Class com.amazonaws.services.codedeploy.model.GenericRevisionInfo extends Object implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A comment about the revision.
    - deploymentGroups
```
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
```
      The deployment groups for which this is the current target revision.
    - firstUsedTime
```
Date firstUsedTime
```
      When the revision was first used by AWS CodeDeploy.
    - lastUsedTime
```
Date lastUsedTime
```
      When the revision was last used by AWS CodeDeploy.
    - registerTime
```
Date registerTime
```
      When the revision was registered with AWS CodeDeploy.
- Class com.amazonaws.services.codedeploy.model.GetApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
- Class com.amazonaws.services.codedeploy.model.GetApplicationResult extends Object implements Serializable
  - Serialized Fields
    - application
```
ApplicationInfo application
```
      Information about the application.
- Class com.amazonaws.services.codedeploy.model.GetApplicationRevisionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of the application that corresponds to the revision.
    - revision
```
RevisionLocation revision
```
      Information about the application revision to get, including type and location.
- Class com.amazonaws.services.codedeploy.model.GetApplicationRevisionResult extends Object implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of the application that corresponds to the revision.
    - revision
```
RevisionLocation revision
```
      Additional information about the revision, including type and location.
    - revisionInfo
```
GenericRevisionInfo revisionInfo
```
      General information about the revision.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentConfigRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentConfigName
```
String deploymentConfigName
```
      The name of a deployment configuration associated with the applicable IAM user or AWS account.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentConfigResult extends Object implements Serializable
  - Serialized Fields
    - deploymentConfigInfo
```
DeploymentConfigInfo deploymentConfigInfo
```
      Information about the deployment configuration.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - deploymentGroupName
```
String deploymentGroupName
```
      The name of an existing deployment group for the specified application.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentGroupResult extends Object implements Serializable
  - Serialized Fields
    - deploymentGroupInfo
```
DeploymentGroupInfo deploymentGroupInfo
```
      Information about the deployment group.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The unique ID of a deployment.
    - instanceId
```
String instanceId
```
      The unique ID of an instance in the deployment group.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentInstanceResult extends Object implements Serializable
  - Serialized Fields
    - instanceSummary
```
InstanceSummary instanceSummary
```
      Information about the instance.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      A deployment ID associated with the applicable IAM user or AWS account.
- Class com.amazonaws.services.codedeploy.model.GetDeploymentResult extends Object implements Serializable
  - Serialized Fields
    - deploymentInfo
```
DeploymentInfo deploymentInfo
```
      Information about the deployment.
- Class com.amazonaws.services.codedeploy.model.GetOnPremisesInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceName
```
String instanceName
```
      The name of the on-premises instance about which to get information.
- Class com.amazonaws.services.codedeploy.model.GetOnPremisesInstanceResult extends Object implements Serializable
  - Serialized Fields
    - instanceInfo
```
InstanceInfo instanceInfo
```
      Information about the on-premises instance.
- Class com.amazonaws.services.codedeploy.model.GitHubLocation extends Object implements Serializable
  - Serialized Fields
    - repository
```
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.
    - commitId
```
String commitId
```
      The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.
- Class com.amazonaws.services.codedeploy.model.IamUserArnAlreadyRegisteredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.IamUserArnRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InstanceDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InstanceIdRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InstanceInfo extends Object implements Serializable
  - Serialized Fields
    - instanceName
```
String instanceName
```
      The name of the on-premises instance.
    - iamUserArn
```
String iamUserArn
```
      The IAM user ARN associated with the on-premises instance.
    - instanceArn
```
String instanceArn
```
      The ARN of the on-premises instance.
    - registerTime
```
Date registerTime
```
      The time at which the on-premises instance was registered.
    - deregisterTime
```
Date deregisterTime
```
      If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      The tags currently associated with the on-premises instance.
- Class com.amazonaws.services.codedeploy.model.InstanceLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InstanceNameAlreadyRegisteredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InstanceNameRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InstanceNotRegisteredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InstanceSummary extends Object implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The deployment ID.
    - instanceId
```
String instanceId
```
      The instance ID.
    - status
```
String status
```
      The deployment status for this instance:
      
      Pending: The deployment is pending for this instance.
      
      In Progress: The deployment is in progress for this instance.
      
      Succeeded: The deployment has succeeded for this instance.
      
      Failed: The deployment has failed for this instance.
      
      Skipped: The deployment has been skipped for this instance.
      
      Unknown: The deployment status is unknown for this instance.
    - lastUpdatedAt
```
Date lastUpdatedAt
```
      A timestamp indicating when the instance information was last updated.
    - lifecycleEvents
```
com.amazonaws.internal.SdkInternalList<T> lifecycleEvents
```
      A list of lifecycle events for this instance.
- Class com.amazonaws.services.codedeploy.model.InvalidApplicationNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidAutoScalingGroupException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidBucketNameFilterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidDeployedStateFilterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidDeploymentStatusException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidEC2TagException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidIamUserArnException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidInstanceNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidInstanceStatusException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidKeyPrefixFilterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidMinimumHealthyHostValueException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidOperationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidRegistrationStatusException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidRevisionException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidRoleException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidSortByException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidSortOrderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidTagException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidTagFilterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidTimeRangeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.InvalidTriggerConfigException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.LifecycleEvent extends Object implements Serializable
  - Serialized Fields
    - lifecycleEventName
```
String lifecycleEventName
```
      The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.
    - diagnostics
```
Diagnostics diagnostics
```
      Diagnostic information about the deployment lifecycle event.
    - startTime
```
Date startTime
```
      A timestamp indicating when the deployment lifecycle event started.
    - endTime
```
Date endTime
```
      A timestamp indicating when the deployment lifecycle event ended.
    - status
```
String status
```
      The deployment lifecycle event status:
      
      Pending: The deployment lifecycle event is pending.
      
      InProgress: The deployment lifecycle event is in progress.
      
      Succeeded: The deployment lifecycle event ran successfully.
      
      Failed: The deployment lifecycle event has failed.
      
      Skipped: The deployment lifecycle event has been skipped.
      
      Unknown: The deployment lifecycle event is unknown.
- Class com.amazonaws.services.codedeploy.model.LifecycleHookLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.ListApplicationRevisionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - sortBy
```
String sortBy
```
      The column name to use to sort the list results:
      
      registerTime: Sort by the time the revisions were registered with AWS CodeDeploy.
      
      firstUsedTime: Sort by the time the revisions were first used in a deployment.
      
      lastUsedTime: Sort by the time the revisions were last used in a deployment.
      
      If not specified or set to null, the results will be returned in an arbitrary order.
    - sortOrder
```
String sortOrder
```
      The order in which to sort the list results:
      
      ascending: ascending order.
      
      descending: descending order.
      
      If not specified, the results will be sorted in ascending order.
      
      If set to null, the results will be sorted in an arbitrary order.
    - s3Bucket
```
String s3Bucket
```
      An Amazon S3 bucket name to limit the search for revisions.
      
      If set to null, all of the user's buckets will be searched.
    - s3KeyPrefix
```
String s3KeyPrefix
```
      A key prefix for the set of Amazon S3 objects to limit the search for revisions.
    - deployed
```
String deployed
```
      Whether to list revisions based on whether the revision is the target revision of an deployment group:
      
      include: List revisions that are target revisions of a deployment group.
      
      exclude: Do not list revisions that are target revisions of a deployment group.
      
      ignore: List all revisions.
    - nextToken
```
String nextToken
```
      An identifier returned from the previous list application revisions call. It can be used to return the next set of applications in the list.
- Class com.amazonaws.services.codedeploy.model.ListApplicationRevisionsResult extends Object implements Serializable
  - Serialized Fields
    - revisions
```
com.amazonaws.internal.SdkInternalList<T> revisions
```
      A list of locations that contain the matching revisions.
    - nextToken
```
String nextToken
```
      If a large amount of information is returned, an identifier will also be returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.
- Class com.amazonaws.services.codedeploy.model.ListApplicationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.
- Class com.amazonaws.services.codedeploy.model.ListApplicationsResult extends Object implements Serializable
  - Serialized Fields
    - applications
```
com.amazonaws.internal.SdkInternalList<T> applications
```
      A list of application names.
    - nextToken
```
String nextToken
```
      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications, will also be returned. in the list.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentConfigsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      An identifier returned from the previous list deployment configurations call. It can be used to return the next set of deployment configurations in the list.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentConfigsResult extends Object implements Serializable
  - Serialized Fields
    - deploymentConfigsList
```
com.amazonaws.internal.SdkInternalList<T> deploymentConfigsList
```
      A list of deployment configurations, including built-in configurations such as CodeDeployDefault.OneAtATime.
    - nextToken
```
String nextToken
```
      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - nextToken
```
String nextToken
```
      An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentGroupsResult extends Object implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The application name.
    - deploymentGroups
```
com.amazonaws.internal.SdkInternalList<T> deploymentGroups
```
      A list of corresponding deployment group names.
    - nextToken
```
String nextToken
```
      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The unique ID of a deployment.
    - nextToken
```
String nextToken
```
      An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.
    - instanceStatusFilter
```
com.amazonaws.internal.SdkInternalList<T> instanceStatusFilter
```
      A subset of instances to list by status:
      
      Pending: Include those instance with pending deployments.
      
      InProgress: Include those instance where deployments are still in progress.
      
      Succeeded: Include those instances with successful deployments.
      
      Failed: Include those instance with failed deployments.
      
      Skipped: Include those instance with skipped deployments.
      
      Unknown: Include those instance with deployments in an unknown state.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentInstancesResult extends Object implements Serializable
  - Serialized Fields
    - instancesList
```
com.amazonaws.internal.SdkInternalList<T> instancesList
```
      A list of instance IDs.
    - nextToken
```
String nextToken
```
      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - deploymentGroupName
```
String deploymentGroupName
```
      The name of an existing deployment group for the specified application.
    - includeOnlyStatuses
```
com.amazonaws.internal.SdkInternalList<T> includeOnlyStatuses
```
      A subset of deployments to list by status:
      
      Created: Include created deployments in the resulting list.
      
      Queued: Include queued deployments in the resulting list.
      
      In Progress: Include in-progress deployments in the resulting list.
      
      Succeeded: Include successful deployments in the resulting list.
      
      Failed: Include failed deployments in the resulting list.
      
      Stopped: Include stopped deployments in the resulting list.
    - createTimeRange
```
TimeRange createTimeRange
```
      A time range (start and end) for returning a subset of the list of deployments.
    - nextToken
```
String nextToken
```
      An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.
- Class com.amazonaws.services.codedeploy.model.ListDeploymentsResult extends Object implements Serializable
  - Serialized Fields
    - deployments
```
com.amazonaws.internal.SdkInternalList<T> deployments
```
      A list of deployment IDs.
    - nextToken
```
String nextToken
```
      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.
- Class com.amazonaws.services.codedeploy.model.ListOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - registrationStatus
```
String registrationStatus
```
      The registration status of the on-premises instances:
      
      Deregistered: Include deregistered on-premises instances in the resulting list.
      
      Registered: Include registered on-premises instances in the resulting list.
    - tagFilters
```
com.amazonaws.internal.SdkInternalList<T> tagFilters
```
      The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned.
    - nextToken
```
String nextToken
```
      An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.
- Class com.amazonaws.services.codedeploy.model.ListOnPremisesInstancesResult extends Object implements Serializable
  - Serialized Fields
    - instanceNames
```
com.amazonaws.internal.SdkInternalList<T> instanceNames
```
      The list of matching on-premises instance names.
    - nextToken
```
String nextToken
```
      If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list on-premises instances call to return the next set of on-premises instances in the list.
- Class com.amazonaws.services.codedeploy.model.MinimumHealthyHosts extends Object implements Serializable
  - Serialized Fields
    - value
```
Integer value
```
      The minimum healthy instance value.
    - type
```
String type
```
      The minimum healthy instance type:
      
      HOST_COUNT: The minimum number of healthy instance as an absolute value.
      
      FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.
      
      In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be successful if six or more instances are deployed to successfully; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.
      In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.
- Class com.amazonaws.services.codedeploy.model.RegisterApplicationRevisionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.
    - description
```
String description
```
      A comment about the revision.
    - revision
```
RevisionLocation revision
```
      Information about the application revision to register, including type and location.
- Class com.amazonaws.services.codedeploy.model.RegisterOnPremisesInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceName
```
String instanceName
```
      The name of the on-premises instance to register.
    - iamUserArn
```
String iamUserArn
```
      The ARN of the IAM user to associate with the on-premises instance.
- Class com.amazonaws.services.codedeploy.model.RemoveTagsFromOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      The tag key-value pairs to remove from the on-premises instances.
    - instanceNames
```
com.amazonaws.internal.SdkInternalList<T> instanceNames
```
      The names of the on-premises instances from which to remove tags.
- Class com.amazonaws.services.codedeploy.model.RevisionDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.RevisionInfo extends Object implements Serializable
  - Serialized Fields
    - revisionLocation
```
RevisionLocation revisionLocation
```
    - genericRevisionInfo
```
GenericRevisionInfo genericRevisionInfo
```
- Class com.amazonaws.services.codedeploy.model.RevisionLocation extends Object implements Serializable
  - Serialized Fields
    - revisionType
```
String revisionType
```
      The type of application revision:
      
      S3: An application revision stored in Amazon S3.
      
      GitHub: An application revision stored in GitHub.
    - s3Location
```
S3Location s3Location
```
    - gitHubLocation
```
GitHubLocation gitHubLocation
```
- Class com.amazonaws.services.codedeploy.model.RevisionRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.RoleRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.S3Location extends Object implements Serializable
  - Serialized Fields
    - bucket
```
String bucket
```
      The name of the Amazon S3 bucket where the application revision is stored.
    - key
```
String key
```
      The name of the Amazon S3 object that represents the bundled artifacts for the application revision.
    - bundleType
```
String bundleType
```
      The file type of the application revision. Must be one of the following:
      
      tar: A tar archive file.
      
      tgz: A compressed tar archive file.
      
      zip: A zip archive file.
    - version
```
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.
    - eTag
```
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.
- Class com.amazonaws.services.codedeploy.model.StopDeploymentRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deploymentId
```
String deploymentId
```
      The unique ID of a deployment.
- Class com.amazonaws.services.codedeploy.model.StopDeploymentResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the stop deployment operation:
      
      Pending: The stop operation is pending.
      
      Succeeded: The stop operation was successful.
    - statusMessage
```
String statusMessage
```
      An accompanying status message.
- Class com.amazonaws.services.codedeploy.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The tag's key.
    - value
```
String value
```
      The tag's value.
- Class com.amazonaws.services.codedeploy.model.TagFilter extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The on-premises instance tag filter key.
    - value
```
String value
```
      The on-premises instance tag filter value.
    - type
```
String type
```
      The on-premises instance tag filter type:
      
      KEY_ONLY: Key only.
      
      VALUE_ONLY: Value only.
      
      KEY_AND_VALUE: Key and value.
- Class com.amazonaws.services.codedeploy.model.TagLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.TagRequiredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.TimeRange extends Object implements Serializable
  - Serialized Fields
    - start
```
Date start
```
      The start time of the time range.
      Specify null to leave the start time open-ended.
    - end
```
Date end
```
      The end time of the time range.
      Specify null to leave the end time open-ended.
- Class com.amazonaws.services.codedeploy.model.TriggerConfig extends Object implements Serializable
  - Serialized Fields
    - triggerName
```
String triggerName
```
      The name of the notification trigger.
    - triggerTargetArn
```
String triggerTargetArn
```
      The ARN of the Amazon Simple Notification Service topic through which notifications about deployment or instance events are sent.
    - triggerEvents
```
com.amazonaws.internal.SdkInternalList<T> triggerEvents
```
      The event type or types for which notifications are triggered.
      
      The following event type values are supported:
      
      DEPLOYMENT_START
      
      DEPLOYMENT_SUCCESS
      
      DEPLOYMENT_FAILURE
      
      DEPLOYMENT_STOP
      
      INSTANCE_START
      
      INSTANCE_SUCCESS
      
      INSTANCE_FAILURE
- Class com.amazonaws.services.codedeploy.model.TriggerTargetsLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codedeploy.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The current name of the application you want to change.
    - newApplicationName
```
String newApplicationName
```
      The new name to give the application.
- Class com.amazonaws.services.codedeploy.model.UpdateDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - applicationName
```
String applicationName
```
      The application name corresponding to the deployment group to update.
    - currentDeploymentGroupName
```
String currentDeploymentGroupName
```
      The current name of the deployment group.
    - newDeploymentGroupName
```
String newDeploymentGroupName
```
      The new name of the deployment group, if you want to change it.
    - deploymentConfigName
```
String deploymentConfigName
```
      The replacement deployment configuration name to use, if you want to change it.
    - ec2TagFilters
```
com.amazonaws.internal.SdkInternalList<T> ec2TagFilters
```
      The replacement set of Amazon EC2 tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
    - onPremisesInstanceTagFilters
```
com.amazonaws.internal.SdkInternalList<T> onPremisesInstanceTagFilters
```
      The replacement set of on-premises instance tags on which to filter, if you want to change them. To keep the existing tags, enter their names. To remove tags, do not enter any tag names.
    - autoScalingGroups
```
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. To keep the Auto Scaling groups, enter their names. To remove Auto Scaling groups, do not enter any Auto Scaling group names.
    - serviceRoleArn
```
String serviceRoleArn
```
      A replacement ARN for the service role, if you want to change it.
    - triggerConfigurations
```
com.amazonaws.internal.SdkInternalList<T> triggerConfigurations
```
      Information about triggers to change when the deployment group is updated.
- Class com.amazonaws.services.codedeploy.model.UpdateDeploymentGroupResult extends Object implements Serializable
  - Serialized Fields
    - hooksNotCleanedUp
```
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 contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.
Package com.amazonaws.services.codepipeline.model
- Class com.amazonaws.services.codepipeline.model.AcknowledgeJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The unique system-generated ID of the job for which you want to confirm receipt.
    - nonce
```
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.
- Class com.amazonaws.services.codepipeline.model.AcknowledgeJobResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      Whether the job worker has received the specified job.
- Class com.amazonaws.services.codepipeline.model.AcknowledgeThirdPartyJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The unique system-generated ID of the job.
    - nonce
```
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.
    - clientToken
```
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.
- Class com.amazonaws.services.codepipeline.model.AcknowledgeThirdPartyJobResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status information for the third party job, if any.
- Class com.amazonaws.services.codepipeline.model.ActionConfiguration extends Object implements Serializable
  - Serialized Fields
    - configuration
```
Map<K,V> configuration
```
      The configuration data for the action.
- Class com.amazonaws.services.codepipeline.model.ActionConfigurationProperty extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the action configuration property.
    - required
```
Boolean required
```
      Whether the configuration property is a required value.
    - key
```
Boolean key
```
      Whether the configuration property is a key.
    - secret
```
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.
    - queryable
```
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.
    - description
```
String description
```
      The description of the action configuration property that will be displayed to users.
    - type
```
String type
```
      The type of the configuration property.
- Class com.amazonaws.services.codepipeline.model.ActionContext extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the action within the context of a job.
- Class com.amazonaws.services.codepipeline.model.ActionDeclaration extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The action declaration's name.
    - actionTypeId
```
ActionTypeId actionTypeId
```
      The configuration information for the action type.
    - runOrder
```
Integer runOrder
```
      The order in which actions are run.
    - configuration
```
Map<K,V> configuration
```
      The action declaration's configuration.
    - outputArtifacts
```
List<E> outputArtifacts
```
      The name or ID of the result of the action declaration, such as a test or build artifact.
    - inputArtifacts
```
List<E> inputArtifacts
```
      The name or ID of the artifact consumed by the action, such as a test or build artifact.
    - roleArn
```
String roleArn
```
      The ARN of the IAM service role that will perform the declared action. This is assumed through the roleArn for the pipeline.
- Class com.amazonaws.services.codepipeline.model.ActionExecution extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status of the action, or for a completed action, the last status of the action.
    - summary
```
String summary
```
      A summary of the run of the action.
    - lastStatusChange
```
Date lastStatusChange
```
      The last status change of the action.
    - externalExecutionId
```
String externalExecutionId
```
      The external ID of the run of the action.
    - externalExecutionUrl
```
String externalExecutionUrl
```
      The URL of a resource external to AWS that will be used when running the action, for example an external repository URL.
    - percentComplete
```
Integer percentComplete
```
      A percentage of completeness of the action as it runs.
    - errorDetails
```
ErrorDetails errorDetails
```
      The details of an error returned by a URL external to AWS.
- Class com.amazonaws.services.codepipeline.model.ActionNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.ActionRevision extends Object implements Serializable
  - Serialized Fields
    - revisionId
```
String revisionId
```
      The system-generated unique ID that identifies the revision number of the action.
    - revisionChangeId
```
String revisionChangeId
```
      The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.
    - created
```
Date created
```
      The date and time when the most recent version of the action was created, in timestamp format.
- Class com.amazonaws.services.codepipeline.model.ActionState extends Object implements Serializable
  - Serialized Fields
    - actionName
```
String actionName
```
      The name of the action.
    - currentRevision
```
ActionRevision currentRevision
```
    - latestExecution
```
ActionExecution latestExecution
```
    - entityUrl
```
String entityUrl
```
      A URL link for more information about the state of the action, such as a deployment group details page.
    - revisionUrl
```
String revisionUrl
```
      A URL link for more information about the revision, such as a commit details page.
- Class com.amazonaws.services.codepipeline.model.ActionType extends Object implements Serializable
  - Serialized Fields
    - id
```
ActionTypeId id
```
    - settings
```
ActionTypeSettings settings
```
      The settings for the action type.
    - actionConfigurationProperties
```
List<E> actionConfigurationProperties
```
      The configuration properties for the action type.
    - inputArtifactDetails
```
ArtifactDetails inputArtifactDetails
```
      The details of the input artifact for the action, such as its commit ID.
    - outputArtifactDetails
```
ArtifactDetails outputArtifactDetails
```
      The details of the output artifact of the action, such as its commit ID.
- Class com.amazonaws.services.codepipeline.model.ActionTypeId extends Object implements Serializable
  - Serialized Fields
    - category
```
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.
    - owner
```
String owner
```
      The creator of the action being called.
    - provider
```
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.
    - version
```
String version
```
      A string that identifies the action type.
- Class com.amazonaws.services.codepipeline.model.ActionTypeNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.ActionTypeSettings extends Object implements Serializable
  - Serialized Fields
    - thirdPartyConfigurationUrl
```
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.
    - entityUrlTemplate
```
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.
    - executionUrlTemplate
```
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.
    - revisionUrlTemplate
```
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.
- Class com.amazonaws.services.codepipeline.model.Artifact extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The artifact's name.
    - revision
```
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).
    - location
```
ArtifactLocation location
```
      The location of an artifact.
- Class com.amazonaws.services.codepipeline.model.ArtifactDetails extends Object implements Serializable
  - Serialized Fields
    - minimumCount
```
Integer minimumCount
```
      The minimum number of artifacts allowed for the action type.
    - maximumCount
```
Integer maximumCount
```
      The maximum number of artifacts allowed for the action type.
- Class com.amazonaws.services.codepipeline.model.ArtifactLocation extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of artifact in the location.
    - s3Location
```
S3ArtifactLocation s3Location
```
      The Amazon S3 bucket that contains the artifact.
- Class com.amazonaws.services.codepipeline.model.ArtifactStore extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of the artifact store, such as S3.
    - location
```
String location
```
      The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.
    - encryptionKey
```
EncryptionKey encryptionKey
```
- Class com.amazonaws.services.codepipeline.model.AWSSessionCredentials extends Object implements Serializable
  - Serialized Fields
    - accessKeyId
```
String accessKeyId
```
      The access key for the session.
    - secretAccessKey
```
String secretAccessKey
```
      The secret access key for the session.
    - sessionToken
```
String sessionToken
```
      The token for the session.
- Class com.amazonaws.services.codepipeline.model.BlockerDeclaration extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the gate declaration.
    - type
```
String type
```
      The type of the gate declaration.
- Class com.amazonaws.services.codepipeline.model.CreateCustomActionTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - category
```
String category
```
      The category of the custom action, such as a source action or a build action.
    - provider
```
String provider
```
      The provider of the service used in the custom action, such as AWS CodeDeploy.
    - version
```
String version
```
      The version number of the custom action.
      A newly-created custom action is always assigned a version number of 1. This is required.
    - settings
```
ActionTypeSettings settings
```
    - configurationProperties
```
List<E> configurationProperties
```
      The configuration properties for the custom action.
    - inputArtifactDetails
```
ArtifactDetails inputArtifactDetails
```
    - outputArtifactDetails
```
ArtifactDetails outputArtifactDetails
```
- Class com.amazonaws.services.codepipeline.model.CreateCustomActionTypeResult extends Object implements Serializable
  - Serialized Fields
    - actionType
```
ActionType actionType
```
- Class com.amazonaws.services.codepipeline.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipeline
```
PipelineDeclaration pipeline
```
- Class com.amazonaws.services.codepipeline.model.CreatePipelineResult extends Object implements Serializable
  - Serialized Fields
    - pipeline
```
PipelineDeclaration pipeline
```
- Class com.amazonaws.services.codepipeline.model.CurrentRevision extends Object implements Serializable
  - Serialized Fields
    - revision
```
String revision
```
      The revision ID of the current version of an artifact.
    - changeIdentifier
```
String changeIdentifier
```
      The change identifier for the current revision.
- Class com.amazonaws.services.codepipeline.model.DeleteCustomActionTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - category
```
String category
```
      The category of the custom action that you want to delete, such as source or deploy.
    - provider
```
String provider
```
      The provider of the service used in the custom action, such as AWS CodeDeploy.
    - version
```
String version
```
      The version of the custom action to delete.
- Class com.amazonaws.services.codepipeline.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the pipeline to be deleted.
- Class com.amazonaws.services.codepipeline.model.DisableStageTransitionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
    - stageName
```
String stageName
```
      The name of the stage where you want to disable the inbound or outbound transition of artifacts.
    - transitionType
```
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).
    - reason
```
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.
- Class com.amazonaws.services.codepipeline.model.EnableStageTransitionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline in which you want to enable the flow of artifacts from one stage to another.
    - stageName
```
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).
    - transitionType
```
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).
- Class com.amazonaws.services.codepipeline.model.EncryptionKey extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
    - type
```
String type
```
- Class com.amazonaws.services.codepipeline.model.ErrorDetails extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The system ID or error number code of the error.
    - message
```
String message
```
      The text of the error message.
- Class com.amazonaws.services.codepipeline.model.ExecutionDetails extends Object implements Serializable
  - Serialized Fields
    - summary
```
String summary
```
      The summary of the current status of the actions.
    - externalExecutionId
```
String externalExecutionId
```
      The system-generated unique ID of this action used to identify this job worker in any external systems, such as AWS CodeDeploy.
    - percentComplete
```
Integer percentComplete
```
      The percentage of work completed on the action, represented on a scale of zero to one hundred percent.
- Class com.amazonaws.services.codepipeline.model.FailureDetails extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of the failure.
    - message
```
String message
```
      The message about the failure.
    - externalExecutionId
```
String externalExecutionId
```
      The external ID of the run of the action that failed.
- Class com.amazonaws.services.codepipeline.model.GetJobDetailsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The unique system-generated ID for the job.
- Class com.amazonaws.services.codepipeline.model.GetJobDetailsResult extends Object implements Serializable
  - Serialized Fields
    - jobDetails
```
JobDetails jobDetails
```
      The details of the job.
      
      If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
- Class com.amazonaws.services.codepipeline.model.GetPipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the pipeline for which you want to get information. Pipeline names must be unique under an Amazon Web Services (AWS) user account.
    - version
```
Integer version
```
      The version number of the pipeline. If you do not specify a version, defaults to the most current version.
- Class com.amazonaws.services.codepipeline.model.GetPipelineResult extends Object implements Serializable
  - Serialized Fields
    - pipeline
```
PipelineDeclaration pipeline
```
- Class com.amazonaws.services.codepipeline.model.GetPipelineStateRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the pipeline about which you want to get information.
- Class com.amazonaws.services.codepipeline.model.GetPipelineStateResult extends Object implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline for which you want to get the state.
    - pipelineVersion
```
Integer pipelineVersion
```
      The version number of the pipeline.
      A newly-created pipeline is always assigned a version number of 1.
    - stageStates
```
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.
    - created
```
Date created
```
      The date and time the pipeline was created, in timestamp format.
    - updated
```
Date updated
```
      The date and time the pipeline was last updated, in timestamp format.
- Class com.amazonaws.services.codepipeline.model.GetThirdPartyJobDetailsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The unique system-generated ID used for identifying the job.
    - clientToken
```
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.
- Class com.amazonaws.services.codepipeline.model.GetThirdPartyJobDetailsResult extends Object implements Serializable
  - Serialized Fields
    - jobDetails
```
ThirdPartyJobDetails jobDetails
```
      The details of the job, including any protected values defined for the job.
- Class com.amazonaws.services.codepipeline.model.InputArtifact extends Object implements Serializable
  - Serialized Fields
    - name
```
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.
- Class com.amazonaws.services.codepipeline.model.InvalidActionDeclarationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidBlockerDeclarationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidClientTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidJobException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidJobStateException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidNonceException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidStageDeclarationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.InvalidStructureException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.Job extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique system-generated ID of the job.
    - data
```
JobData data
```
      Additional data about a job.
    - nonce
```
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.
    - accountId
```
String accountId
```
      The ID of the AWS account to use when performing the job.
- Class com.amazonaws.services.codepipeline.model.JobData extends Object implements Serializable
  - Serialized Fields
    - actionTypeId
```
ActionTypeId actionTypeId
```
    - actionConfiguration
```
ActionConfiguration actionConfiguration
```
    - pipelineContext
```
PipelineContext pipelineContext
```
    - inputArtifacts
```
List<E> inputArtifacts
```
      The artifact supplied to the job.
    - outputArtifacts
```
List<E> outputArtifacts
```
      The output of the job.
    - artifactCredentials
```
AWSSessionCredentials artifactCredentials
```
    - continuationToken
```
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 encryptionKey
```
- Class com.amazonaws.services.codepipeline.model.JobDetails extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The unique system-generated ID of the job.
    - data
```
JobData data
```
    - accountId
```
String accountId
```
      The AWS account ID associated with the job.
- Class com.amazonaws.services.codepipeline.model.JobNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.ListActionTypesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - actionOwnerFilter
```
String actionOwnerFilter
```
      Filters the list of action types to those created by a specified entity.
    - nextToken
```
String nextToken
```
      An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.
- Class com.amazonaws.services.codepipeline.model.ListActionTypesResult extends Object implements Serializable
  - Serialized Fields
    - actionTypes
```
List<E> actionTypes
```
      Provides details of the action types.
    - nextToken
```
String nextToken
```
      If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list action types call to return the next set of action types in the list.
- Class com.amazonaws.services.codepipeline.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
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.
- Class com.amazonaws.services.codepipeline.model.ListPipelinesResult extends Object implements Serializable
  - Serialized Fields
    - pipelines
```
List<E> pipelines
```
      The list of pipelines.
    - nextToken
```
String nextToken
```
      If the amount of returned information is significantly large, an identifier is also returned which can be used in a subsequent list pipelines call to return the next set of pipelines in the list.
- Class com.amazonaws.services.codepipeline.model.OutputArtifact extends Object implements Serializable
  - Serialized Fields
    - name
```
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.
- Class com.amazonaws.services.codepipeline.model.PipelineContext extends Object implements Serializable
  - Serialized Fields
    - pipelineName
```
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.
    - stage
```
StageContext stage
```
      The stage of the pipeline.
    - action
```
ActionContext action
```
- Class com.amazonaws.services.codepipeline.model.PipelineDeclaration extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the action to be performed.
    - roleArn
```
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 artifactStore
```
    - stages
```
List<E> stages
```
      The stage in which to perform the action.
    - version
```
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.
- Class com.amazonaws.services.codepipeline.model.PipelineNameInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.PipelineNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.PipelineSummary extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the pipeline.
    - version
```
Integer version
```
      The version number of the pipeline.
    - created
```
Date created
```
      The date and time the pipeline was created, in timestamp format.
    - updated
```
Date updated
```
      The date and time of the last update to the pipeline, in timestamp format.
- Class com.amazonaws.services.codepipeline.model.PipelineVersionNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.PollForJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - actionTypeId
```
ActionTypeId actionTypeId
```
    - maxBatchSize
```
Integer maxBatchSize
```
      The maximum number of jobs to return in a poll for jobs call.
    - queryParam
```
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.
- Class com.amazonaws.services.codepipeline.model.PollForJobsResult extends Object implements Serializable
  - Serialized Fields
    - jobs
```
List<E> jobs
```
      Information about the jobs to take action on.
- Class com.amazonaws.services.codepipeline.model.PollForThirdPartyJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - actionTypeId
```
ActionTypeId actionTypeId
```
    - maxBatchSize
```
Integer maxBatchSize
```
      The maximum number of jobs to return in a poll for jobs call.
- Class com.amazonaws.services.codepipeline.model.PollForThirdPartyJobsResult extends Object implements Serializable
  - Serialized Fields
    - jobs
```
List<E> jobs
```
      Information about the jobs to take action on.
- Class com.amazonaws.services.codepipeline.model.PutActionRevisionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineName
```
String pipelineName
```
      The name of the pipeline that will start processing the revision to the source.
    - stageName
```
String stageName
```
      The name of the stage that contains the action that will act upon the revision.
    - actionName
```
String actionName
```
      The name of the action that will process the revision.
    - actionRevision
```
ActionRevision actionRevision
```
- Class com.amazonaws.services.codepipeline.model.PutActionRevisionResult extends Object implements Serializable
  - Serialized Fields
    - newRevision
```
Boolean newRevision
```
      The new revision number or ID for the revision after the action completes.
    - pipelineExecutionId
```
String pipelineExecutionId
```
      The ID of the current workflow state of the pipeline.
- Class com.amazonaws.services.codepipeline.model.PutJobFailureResultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.
    - failureDetails
```
FailureDetails failureDetails
```
      The details about the failure of a job.
- Class com.amazonaws.services.codepipeline.model.PutJobSuccessResultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.
    - currentRevision
```
CurrentRevision currentRevision
```
      The ID of the current revision of the artifact successfully worked upon by the job.
    - continuationToken
```
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 executionDetails
```
      The execution details of the successful job, such as the actions taken by the job worker.
- Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobFailureResultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.
    - clientToken
```
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 failureDetails
```
- Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobSuccessResultRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - jobId
```
String jobId
```
      The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.
    - clientToken
```
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 currentRevision
```
    - continuationToken
```
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 executionDetails
```
- Class com.amazonaws.services.codepipeline.model.S3ArtifactLocation extends Object implements Serializable
  - Serialized Fields
    - bucketName
```
String bucketName
```
      The name of the Amazon S3 bucket.
    - objectKey
```
String objectKey
```
      The key of the object in the Amazon S3 bucket, which uniquely identifies the object in the bucket.
- Class com.amazonaws.services.codepipeline.model.StageContext extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the stage.
- Class com.amazonaws.services.codepipeline.model.StageDeclaration extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the stage.
    - blockers
```
List<E> blockers
```
      The gates included in a stage.
    - actions
```
List<E> actions
```
      The actions included in a stage.
- Class com.amazonaws.services.codepipeline.model.StageNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.codepipeline.model.StageState extends Object implements Serializable
  - Serialized Fields
    - stageName
```
String stageName
```
      The name of the stage.
    - inboundTransitionState
```
TransitionState inboundTransitionState
```
      The state of the inbound transition, which is either enabled or disabled.
    - actionStates
```
List<E> actionStates
```
      The state of the stage.
- Class com.amazonaws.services.codepipeline.model.StartPipelineExecutionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the pipeline to start.
- Class com.amazonaws.services.codepipeline.model.StartPipelineExecutionResult extends Object implements Serializable
  - Serialized Fields
    - pipelineExecutionId
```
String pipelineExecutionId
```
      The unique system-generated ID of the pipeline that was started.
- Class com.amazonaws.services.codepipeline.model.ThirdPartyJob extends Object implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      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.
    - jobId
```
String jobId
```
      The identifier used to identify the job in AWS CodePipeline.
- Class com.amazonaws.services.codepipeline.model.ThirdPartyJobData extends Object implements Serializable
  - Serialized Fields
    - actionTypeId
```
ActionTypeId actionTypeId
```
    - actionConfiguration
```
ActionConfiguration actionConfiguration
```
    - pipelineContext
```
PipelineContext pipelineContext
```
    - inputArtifacts
```
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.
    - outputArtifacts
```
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.
    - artifactCredentials
```
AWSSessionCredentials artifactCredentials
```
    - continuationToken
```
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 encryptionKey
```
- Class com.amazonaws.services.codepipeline.model.ThirdPartyJobDetails extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier used to identify the job details in AWS CodePipeline.
    - data
```
ThirdPartyJobData data
```
      The data to be returned by the third party job worker.
    - nonce
```
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.
- Class com.amazonaws.services.codepipeline.model.TransitionState extends Object implements Serializable
  - Serialized Fields
    - enabled
```
Boolean enabled
```
      Whether the transition between stages is enabled (true) or disabled (false).
    - lastChangedBy
```
String lastChangedBy
```
      The ID of the user who last changed the transition state.
    - lastChangedAt
```
Date lastChangedAt
```
      The timestamp when the transition state was last changed.
    - disabledReason
```
String disabledReason
```
      The user-specified reason why the transition between two stages of a pipeline was disabled.
- Class com.amazonaws.services.codepipeline.model.UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipeline
```
PipelineDeclaration pipeline
```
      The name of the pipeline to be updated.
- Class com.amazonaws.services.codepipeline.model.UpdatePipelineResult extends Object implements Serializable
  - Serialized Fields
    - pipeline
```
PipelineDeclaration pipeline
```
      The structure of the updated pipeline.
- Class com.amazonaws.services.codepipeline.model.ValidationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.cognitoidentity.model
- Class com.amazonaws.services.cognitoidentity.model.CognitoIdentityProvider extends Object implements Serializable
  - Serialized Fields
    - providerName
```
String providerName
```
      The provider name for a Cognito User Identity Pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.
    - clientId
```
String clientId
```
      The client ID for the Cognito User Identity Pool.
- Class com.amazonaws.services.cognitoidentity.model.ConcurrentModificationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolName
```
String identityPoolName
```
      A string that you provide.
    - allowUnauthenticatedIdentities
```
Boolean allowUnauthenticatedIdentities
```
      TRUE if the identity pool supports unauthenticated logins.
    - supportedLoginProviders
```
Map<K,V> supportedLoginProviders
```
      Optional key:value pairs mapping provider names to provider app IDs.
    - developerProviderName
```
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.
    - openIdConnectProviderARNs
```
List<E> openIdConnectProviderARNs
```
      A list of OpendID Connect provider ARNs.
    - cognitoIdentityProviders
```
List<E> cognitoIdentityProviders
```
      A list representing a Cognito User Identity Pool and its client ID.
- Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identityPoolName
```
String identityPoolName
```
      A string that you provide.
    - allowUnauthenticatedIdentities
```
Boolean allowUnauthenticatedIdentities
```
      TRUE if the identity pool supports unauthenticated logins.
    - supportedLoginProviders
```
Map<K,V> supportedLoginProviders
```
      Optional key:value pairs mapping provider names to provider app IDs.
    - developerProviderName
```
String developerProviderName
```
      The "domain" by which Cognito will refer to your users.
    - openIdConnectProviderARNs
```
List<E> openIdConnectProviderARNs
```
      A list of OpendID Connect provider ARNs.
    - cognitoIdentityProviders
```
List<E> cognitoIdentityProviders
```
      A list representing a Cognito User Identity Pool and its client ID.
- Class com.amazonaws.services.cognitoidentity.model.Credentials extends Object implements Serializable
  - Serialized Fields
    - accessKeyId
```
String accessKeyId
```
      The Access Key portion of the credentials.
    - secretKey
```
String secretKey
```
      The Secret Access Key portion of the credentials
    - sessionToken
```
String sessionToken
```
      The Session Token portion of the credentials
    - expiration
```
Date expiration
```
      The date at which these credentials will expire.
- Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityIdsToDelete
```
List<E> identityIdsToDelete
```
      A list of 1-60 identities that you want to delete.
- Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesResult extends Object implements Serializable
  - Serialized Fields
    - unprocessedIdentityIds
```
List<E> unprocessedIdentityIds
```
      An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.
- Class com.amazonaws.services.cognitoidentity.model.DeleteIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
- Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
- Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identityPoolName
```
String identityPoolName
```
      A string that you provide.
    - allowUnauthenticatedIdentities
```
Boolean allowUnauthenticatedIdentities
```
      TRUE if the identity pool supports unauthenticated logins.
    - supportedLoginProviders
```
Map<K,V> supportedLoginProviders
```
      Optional key:value pairs mapping provider names to provider app IDs.
    - developerProviderName
```
String developerProviderName
```
      The "domain" by which Cognito will refer to your users.
    - openIdConnectProviderARNs
```
List<E> openIdConnectProviderARNs
```
      A list of OpendID Connect provider ARNs.
    - cognitoIdentityProviders
```
List<E> cognitoIdentityProviders
```
      A list representing a Cognito User Identity Pool and its client ID.
- Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
- Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityResult extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - logins
```
List<E> logins
```
      A set of optional name-value pairs that map provider names to provider tokens.
    - creationDate
```
Date creationDate
```
      Date on which the identity was created.
    - lastModifiedDate
```
Date lastModifiedDate
```
      Date on which the identity was last modified.
- Class com.amazonaws.services.cognitoidentity.model.DeveloperUserAlreadyRegisteredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.ExternalServiceException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - logins
```
Map<K,V> logins
```
      A set of optional name-value pairs that map provider names to provider tokens.
- Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityResult extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - credentials
```
Credentials credentials
```
      Credentials for the provided identity ID.
- Class com.amazonaws.services.cognitoidentity.model.GetIdentityPoolRolesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
- Class com.amazonaws.services.cognitoidentity.model.GetIdentityPoolRolesResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - roles
```
Map<K,V> roles
```
      The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.
- Class com.amazonaws.services.cognitoidentity.model.GetIdRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accountId
```
String accountId
```
      A standard AWS account ID (9+ digits).
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - logins
```
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:
      
      Facebook: graph.facebook.com
      
      Amazon Cognito Identity Provider: cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789
      
      Google: accounts.google.com
      
      Amazon: www.amazon.com
      
      Twitter: api.twitter.com
      
      Digits: www.digits.com
- Class com.amazonaws.services.cognitoidentity.model.GetIdResult extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
- Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - logins
```
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.
    - tokenDuration
```
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.
- Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenForDeveloperIdentityResult extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - token
```
String token
```
      An OpenID token.
- Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - logins
```
Map<K,V> logins
```
      A set of optional name-value pairs that map provider names to provider tokens. When using graph.facebook.com and www.amazon.com, supply the access_token returned from the provider's authflow. For accounts.google.com, an Amazon Cognito Identity Provider, or any other OpenId Connect provider, always include the id_token.
- Class com.amazonaws.services.cognitoidentity.model.GetOpenIdTokenResult extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID. Note that the IdentityId returned may not match the one passed on input.
    - token
```
String token
```
      An OpenID token, valid for 15 minutes.
- Class com.amazonaws.services.cognitoidentity.model.IdentityDescription extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - logins
```
List<E> logins
```
      A set of optional name-value pairs that map provider names to provider tokens.
    - creationDate
```
Date creationDate
```
      Date on which the identity was created.
    - lastModifiedDate
```
Date lastModifiedDate
```
      Date on which the identity was last modified.
- Class com.amazonaws.services.cognitoidentity.model.IdentityPoolShortDescription extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identityPoolName
```
String identityPoolName
```
      A string that you provide.
- Class com.amazonaws.services.cognitoidentity.model.InternalErrorException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.InvalidIdentityPoolConfigurationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.InvalidParameterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - maxResults
```
Integer maxResults
```
      The maximum number of identities to return.
    - nextToken
```
String nextToken
```
      A pagination token.
    - hideDisabled
```
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.
- Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identities
```
List<E> identities
```
      An object containing a set of identities and associated mappings.
    - nextToken
```
String nextToken
```
      A pagination token.
- Class com.amazonaws.services.cognitoidentity.model.ListIdentityPoolsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of identities to return.
    - nextToken
```
String nextToken
```
      A pagination token.
- Class com.amazonaws.services.cognitoidentity.model.ListIdentityPoolsResult extends Object implements Serializable
  - Serialized Fields
    - identityPools
```
List<E> identityPools
```
      The identity pools returned by the ListIdentityPools action.
    - nextToken
```
String nextToken
```
      A pagination token.
- Class com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - developerUserIdentifier
```
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.
    - maxResults
```
Integer maxResults
```
      The maximum number of identities to return.
    - nextToken
```
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.
- Class com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityResult extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - developerUserIdentifierList
```
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.
    - nextToken
```
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.
- Class com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sourceUserIdentifier
```
String sourceUserIdentifier
```
      User identifier for the source user. The value should be a DeveloperUserIdentifier.
    - destinationUserIdentifier
```
String destinationUserIdentifier
```
      User identifier for the destination user. The value should be a DeveloperUserIdentifier.
    - developerProviderName
```
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 (-).
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
- Class com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesResult extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
- Class com.amazonaws.services.cognitoidentity.model.NotAuthorizedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.ResourceConflictException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.SetIdentityPoolRolesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - roles
```
Map<K,V> roles
```
      The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.
- Class com.amazonaws.services.cognitoidentity.model.TooManyRequestsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidentity.model.UnlinkDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - developerProviderName
```
String developerProviderName
```
      The "domain" by which Cognito will refer to your users.
    - developerUserIdentifier
```
String developerUserIdentifier
```
      A unique ID used by your backend authentication process to identify a user.
- Class com.amazonaws.services.cognitoidentity.model.UnlinkIdentityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - logins
```
Map<K,V> logins
```
      A set of optional name-value pairs that map provider names to provider tokens.
    - loginsToRemove
```
List<E> loginsToRemove
```
      Provider names to unlink from this identity.
- Class com.amazonaws.services.cognitoidentity.model.UnprocessedIdentityId extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A unique identifier in the format REGION:GUID.
    - errorCode
```
String errorCode
```
      The error code indicating the type of error that occurred.
- Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identityPoolName
```
String identityPoolName
```
      A string that you provide.
    - allowUnauthenticatedIdentities
```
Boolean allowUnauthenticatedIdentities
```
      TRUE if the identity pool supports unauthenticated logins.
    - supportedLoginProviders
```
Map<K,V> supportedLoginProviders
```
      Optional key:value pairs mapping provider names to provider app IDs.
    - developerProviderName
```
String developerProviderName
```
      The "domain" by which Cognito will refer to your users.
    - openIdConnectProviderARNs
```
List<E> openIdConnectProviderARNs
```
      A list of OpendID Connect provider ARNs.
    - cognitoIdentityProviders
```
List<E> cognitoIdentityProviders
```
      A list representing a Cognito User Identity Pool and its client ID.
- Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      An identity pool ID in the format REGION:GUID.
    - identityPoolName
```
String identityPoolName
```
      A string that you provide.
    - allowUnauthenticatedIdentities
```
Boolean allowUnauthenticatedIdentities
```
      TRUE if the identity pool supports unauthenticated logins.
    - supportedLoginProviders
```
Map<K,V> supportedLoginProviders
```
      Optional key:value pairs mapping provider names to provider app IDs.
    - developerProviderName
```
String developerProviderName
```
      The "domain" by which Cognito will refer to your users.
    - openIdConnectProviderARNs
```
List<E> openIdConnectProviderARNs
```
      A list of OpendID Connect provider ARNs.
    - cognitoIdentityProviders
```
List<E> cognitoIdentityProviders
```
      A list representing a Cognito User Identity Pool and its client ID.
Package com.amazonaws.services.cognitoidp.model
- Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to add custom attributes.
    - customAttributes
```
List<E> customAttributes
```
      An array of custom attributes, such as Mutable and Name.
- Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for which you want to confirm user registration.
    - username
```
String username
```
      The user name for which you want to confirm user registration.
- Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to delete user attributes.
    - username
```
String username
```
      The user name of the user from which you would like to delete attributes.
    - userAttributeNames
```
List<E> userAttributeNames
```
      An array of strings representing the user attribute names you wish to delete.
- Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to delete the user.
    - username
```
String username
```
      The user name of the user you wish to delete.
- Class com.amazonaws.services.cognitoidp.model.AdminDisableUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to disable the user.
    - username
```
String username
```
      The user name of the user you wish to disable.
- Class com.amazonaws.services.cognitoidp.model.AdminDisableUserResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminEnableUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to enable the user.
    - username
```
String username
```
      The user name of the user you wish to ebable.
- Class com.amazonaws.services.cognitoidp.model.AdminEnableUserResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminGetUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to get information about the user.
    - username
```
String username
```
      The user name of the user you wish to retrieve.
- Class com.amazonaws.services.cognitoidp.model.AdminGetUserResult extends Object implements Serializable
  - Serialized Fields
    - username
```
String username
```
      The user name of the user about whom you are receiving information.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
    - userCreateDate
```
Date userCreateDate
```
      The date the user was created.
    - userLastModifiedDate
```
Date userLastModifiedDate
```
      The date the user was last modified.
    - enabled
```
Boolean enabled
```
      Indicates that the status is enabled.
    - userStatus
```
String userStatus
```
      The user status. Can be one of the following:
      
      UNCONFIRMED - User has been created but not confirmed.
      
      CONFIRMED - User has been confirmed.
      
      ARCHIVED - User is no longer active.
      
      COMPROMISED - User is disabled due to a potential security threat.
      
      UNKNOWN - User status is not known.
    - mFAOptions
```
List<E> mFAOptions
```
      Specifies the options for MFA (e.g., email or phone number).
- Class com.amazonaws.services.cognitoidp.model.AdminResetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to reset the user's password.
    - username
```
String username
```
      The user name of the user whose password you wish to reset.
- Class com.amazonaws.services.cognitoidp.model.AdminResetUserPasswordResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
    - username
```
String username
```
      The user name of the user for whom you wish to set user settings.
    - mFAOptions
```
List<E> mFAOptions
```
      Specifies the options for MFA (e.g., email or phone number).
- Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to update user attributes.
    - username
```
String username
```
      The user name of the user for whom you want to update user attributes.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
- Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.AliasExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.AttributeType extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the attribute.
    - value
```
String value
```
      The value of the attribute.
- Class com.amazonaws.services.cognitoidp.model.ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - previousPassword
```
String previousPassword
```
      The old password in the change password request.
    - proposedPassword
```
String proposedPassword
```
      The new password in the change password request.
    - accessToken
```
String accessToken
```
      The access token in the change password request.
- Class com.amazonaws.services.cognitoidp.model.ChangePasswordResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.CodeDeliveryDetailsType extends Object implements Serializable
  - Serialized Fields
    - destination
```
String destination
```
      The destination for the code delivery details.
    - deliveryMedium
```
String deliveryMedium
```
      The delivery medium (email message or phone number).
    - attributeName
```
String attributeName
```
      The name of the attribute in the code delivery details type.
- Class com.amazonaws.services.cognitoidp.model.CodeMismatchException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ConcurrentModificationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    - username
```
String username
```
      The user name of the user for whom you want to enter a code to retrieve a forgotten password.
    - confirmationCode
```
String confirmationCode
```
      The confirmation code sent by a user's request to retrieve a forgotten password.
    - password
```
String password
```
      The password sent by sent by a user's request to retrieve a forgotten password.
- Class com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    - username
```
String username
```
      The user name of the user whose registration you wish to confirm.
    - confirmationCode
```
String confirmationCode
```
      The confirmation code sent by a user's request to confirm registration.
    - forceAliasCreation
```
Boolean forceAliasCreation
```
      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
- Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to create a user pool client.
    - clientName
```
String clientName
```
      The client name for the user pool client you would like to create.
    - generateSecret
```
Boolean generateSecret
```
      Boolean to specify whether you want to generate a secret for the user pool client being created.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientResult extends Object implements Serializable
  - Serialized Fields
    - userPoolClient
```
UserPoolClientType userPoolClient
```
      The user pool client that was just created.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - poolName
```
String poolName
```
      A string used to name the user pool.
    - policies
```
UserPoolPolicyType policies
```
      The policies associated with the new user pool.
    - lambdaConfig
```
LambdaConfigType lambdaConfig
```
      The Lambda trigger configuration information for the new user pool.
    - autoVerifiedAttributes
```
List<E> autoVerifiedAttributes
```
      The attributes to be auto-verified. Possible values: email, phone_number.
    - aliasAttributes
```
List<E> aliasAttributes
```
      Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.
    - smsVerificationMessage
```
String smsVerificationMessage
```
      A string representing the SMS verification message.
    - emailVerificationMessage
```
String emailVerificationMessage
```
      A string representing the email verification message.
    - emailVerificationSubject
```
String emailVerificationSubject
```
      A string representing the email verification subject.
    - smsAuthenticationMessage
```
String smsAuthenticationMessage
```
      A string representing the SMS authentication message.
    - mfaConfiguration
```
String mfaConfiguration
```
      Specifies MFA configuration details.
- Class com.amazonaws.services.cognitoidp.model.CreateUserPoolResult extends Object implements Serializable
  - Serialized Fields
    - userPool
```
UserPoolType userPool
```
      A container for the user pool details.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userAttributeNames
```
List<E> userAttributeNames
```
      An array of strings representing the user attribute names you wish to delete.
    - accessToken
```
String accessToken
```
      The access token used in the request to delete user attributes.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to delete the client.
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool you want to delete.
- Class com.amazonaws.services.cognitoidp.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      The access token from a request to delete a user.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool you want to describe.
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientResult extends Object implements Serializable
  - Serialized Fields
    - userPoolClient
```
UserPoolClientType userPoolClient
```
      The user pool client from a server response to describe the user pool client.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool you want to describe.
- Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolResult extends Object implements Serializable
  - Serialized Fields
    - userPool
```
UserPoolType userPool
```
      The container of metadata returned by the server to describe the pool.
- Class com.amazonaws.services.cognitoidp.model.ExpiredCodeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    - username
```
String username
```
      The user name of the user for whom you want to enter a code to retrieve a forgotten password.
- Class com.amazonaws.services.cognitoidp.model.ForgotPasswordResult extends Object implements Serializable
  - Serialized Fields
    - codeDeliveryDetails
```
CodeDeliveryDetailsType codeDeliveryDetails
```
- Class com.amazonaws.services.cognitoidp.model.GetJWKSRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to get JSON Web keys.
- Class com.amazonaws.services.cognitoidp.model.GetJWKSResult extends Object implements Serializable
  - Serialized Fields
    - keys
```
List<E> keys
```
      The keys in a get JSON Web keys response.
- Class com.amazonaws.services.cognitoidp.model.GetOpenIdConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to get Open ID configuration information.
- Class com.amazonaws.services.cognitoidp.model.GetOpenIdConfigurationResult extends Object implements Serializable
  - Serialized Fields
    - issuer
```
String issuer
```
      The issuer of the Open ID configuration response.
    - jwks_uri
```
String jwks_uri
```
      The URI of the JSON Web keys in the server response to get Open ID configuration information.
    - authorization_endpoint
```
String authorization_endpoint
```
      The authorization endpoint returned by the server response to get the Open ID configuration information.
    - subject_types_supported
```
List<E> subject_types_supported
```
      The subject types supported returned by the server response to get the Open ID configuration information.
    - response_types_supported
```
List<E> response_types_supported
```
      The response types supported returned by the server response to get the Open ID configuration information.
    - id_token_signing_alg_values_supported
```
List<E> id_token_signing_alg_values_supported
```
      The token-signing algorithm values supported returned by the server response to get the Open ID configuration information.
- Class com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      The access token returned by the server response to get the user attribute verification code.
    - attributeName
```
String attributeName
```
      The attribute name returned by the server response to get the user attribute verification code.
- Class com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeResult extends Object implements Serializable
  - Serialized Fields
    - codeDeliveryDetails
```
CodeDeliveryDetailsType codeDeliveryDetails
```
      The code delivery details returned by the server response to get the user attribute verification code.
- Class com.amazonaws.services.cognitoidp.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      The access token returned by the server response to get information about the user.
- Class com.amazonaws.services.cognitoidp.model.GetUserResult extends Object implements Serializable
  - Serialized Fields
    - username
```
String username
```
      The user name of the user you wish to retrieve from the get user request.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
    - mFAOptions
```
List<E> mFAOptions
```
      Specifies the options for MFA (e.g., email or phone number).
- Class com.amazonaws.services.cognitoidp.model.InternalErrorException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidLambdaResponseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidParameterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.InvalidPasswordException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.KeyType extends Object implements Serializable
  - Serialized Fields
    - kty
```
String kty
```
      A "kty" key type parameter. For more information, see JSON Web Key (JWK) Format.
    - alg
```
String alg
```
      A "kty" (Key Type) parameter. For more information, see "kty" (Key Type) Parameter.
    - use
```
String use
```
      A "use" (Public Key Use) parameter. For more information, see "use" (Public Key Use) Parameter.
    - kid
```
String kid
```
      A "kid" (Key ID) parameter. For more information, see "kid" (Key ID) Parameter.
    - n
```
String n
```
      An "n" parameter.
    - e
```
String e
```
      An "e" parameter.
- Class com.amazonaws.services.cognitoidp.model.LambdaConfigType extends Object implements Serializable
  - Serialized Fields
    - preSignUp
```
String preSignUp
```
      A pre-registration AWS Lambda trigger.
    - customMessage
```
String customMessage
```
      A custom Message AWS Lambda trigger.
    - postConfirmation
```
String postConfirmation
```
      A post-confirmation AWS Lambda trigger.
    - preAuthentication
```
String preAuthentication
```
      A pre-authentication AWS Lambda trigger.
    - postAuthentication
```
String postAuthentication
```
      A post-authentication AWS Lambda trigger.
- Class com.amazonaws.services.cognitoidp.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.ListUserPoolClientsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to list user pool clients.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return when listing the user pool clients.
    - nextToken
```
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.
- Class com.amazonaws.services.cognitoidp.model.ListUserPoolClientsResult extends Object implements Serializable
  - Serialized Fields
    - userPoolClients
```
List<E> userPoolClients
```
      The user pool clients in the response that lists user pool clients.
    - nextToken
```
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.
- Class com.amazonaws.services.cognitoidp.model.ListUserPoolsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
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.
    - maxResults
```
Integer maxResults
```
      The maximum number of results you want the request to return when listing the user pools.
- Class com.amazonaws.services.cognitoidp.model.ListUserPoolsResult extends Object implements Serializable
  - Serialized Fields
    - userPools
```
List<E> userPools
```
      The user pools from the response to list users.
    - nextToken
```
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.
- Class com.amazonaws.services.cognitoidp.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for which you want to list users.
    - attributesToGet
```
List<E> attributesToGet
```
      The attributes to get from the request to list users.
    - limit
```
Integer limit
```
      The limit of the request to list users.
    - paginationToken
```
String paginationToken
```
      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.
    - userStatus
```
String userStatus
```
      The user status. Can be one of the following:
      
      UNCONFIRMED - User has been created but not confirmed.
      
      CONFIRMED - User has been confirmed.
      
      ARCHIVED - User is no longer active.
      
      COMPROMISED - User is disabled due to a potential security threat.
      
      UNKNOWN - User status is not known.
- Class com.amazonaws.services.cognitoidp.model.ListUsersResult extends Object implements Serializable
  - Serialized Fields
    - users
```
List<E> users
```
      The users returned in the request to list users.
    - paginationToken
```
String paginationToken
```
      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.
- Class com.amazonaws.services.cognitoidp.model.MFAOptionType extends Object implements Serializable
  - Serialized Fields
    - deliveryMedium
```
String deliveryMedium
```
      The delivery medium (email message or SMS message) to send the MFA code.
    - attributeName
```
String attributeName
```
      The attribute name of the MFA option type.
- Class com.amazonaws.services.cognitoidp.model.NotAuthorizedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.NumberAttributeConstraintsType extends Object implements Serializable
  - Serialized Fields
    - minValue
```
String minValue
```
      The minimum value of an attribute that is of the number data type.
    - maxValue
```
String maxValue
```
      The maximum value of an attribute that is of the number data type.
- Class com.amazonaws.services.cognitoidp.model.PasswordPolicyType extends Object implements Serializable
  - Serialized Fields
    - minimumLength
```
Integer minimumLength
```
      The minimum length of the password policy that you have set. Cannot be less than 6.
    - requireUppercase
```
Boolean requireUppercase
```
      In the password policy that you have set, refers to whether you have required users to use at least one uppercase letter in their password.
    - requireLowercase
```
Boolean requireLowercase
```
      In the password policy that you have set, refers to whether you have required users to use at least one lowercase letter in their password.
    - requireNumbers
```
Boolean requireNumbers
```
      In the password policy that you have set, refers to whether you have required users to use at least one number in their password.
    - requireSymbols
```
Boolean requireSymbols
```
      In the password policy that you have set, refers to whether you have required users to use at least one symbol in their password.
- Class com.amazonaws.services.cognitoidp.model.ResendConfirmationCodeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    - username
```
String username
```
      The user name of the user to whom you wish to resend a confirmation code.
- Class com.amazonaws.services.cognitoidp.model.ResendConfirmationCodeResult extends Object implements Serializable
  - Serialized Fields
    - codeDeliveryDetails
```
CodeDeliveryDetailsType codeDeliveryDetails
```
- Class com.amazonaws.services.cognitoidp.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.SchemaAttributeType extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      A schema attribute of the name type.
    - attributeDataType
```
String attributeDataType
```
      The attribute data type.
    - developerOnlyAttribute
```
Boolean developerOnlyAttribute
```
      Specifies whether the attribute type is developer only.
    - mutable
```
Boolean mutable
```
      Specifies whether the attribute can be changed once it has been created.
    - required
```
Boolean required
```
      Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.
    - numberAttributeConstraints
```
NumberAttributeConstraintsType numberAttributeConstraints
```
      Specifies the constraints for an attribute of the number type.
    - stringAttributeConstraints
```
StringAttributeConstraintsType stringAttributeConstraints
```
      Specifies the constraints for an attribute of the string type.
- Class com.amazonaws.services.cognitoidp.model.SetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      The access token for the set user settings request.
    - mFAOptions
```
List<E> mFAOptions
```
      Specifies the options for MFA (e.g., email or phone number).
- Class com.amazonaws.services.cognitoidp.model.SetUserSettingsResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.SignUpRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - secretHash
```
String secretHash
```
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    - username
```
String username
```
      The user name of the user you wish to register.
    - password
```
String password
```
      The password of the user you wish to register.
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
    - validationData
```
List<E> validationData
```
      The validation data in the request to register a user.
- Class com.amazonaws.services.cognitoidp.model.SignUpResult extends Object implements Serializable
  - Serialized Fields
    - userConfirmed
```
Boolean userConfirmed
```
      A response from the server indicating that a user registration has been confirmed.
    - codeDeliveryDetails
```
CodeDeliveryDetailsType codeDeliveryDetails
```
- Class com.amazonaws.services.cognitoidp.model.StringAttributeConstraintsType extends Object implements Serializable
  - Serialized Fields
    - minLength
```
String minLength
```
      The minimum length of an attribute value of the string type.
    - maxLength
```
String maxLength
```
      The maximum length of an attribute value of the string type.
- Class com.amazonaws.services.cognitoidp.model.TooManyFailedAttemptsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.TooManyRequestsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.UnexpectedLambdaException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.UpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userAttributes
```
List<E> userAttributes
```
      An array of name-value pairs representing user attributes.
    - accessToken
```
String accessToken
```
      The access token for the request to update user attributes.
- Class com.amazonaws.services.cognitoidp.model.UpdateUserAttributesResult extends Object implements Serializable
  - Serialized Fields
    - codeDeliveryDetailsList
```
List<E> codeDeliveryDetailsList
```
      The code delivery details list from the server for the request to update user attributes.
- Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to update the user pool client.
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - clientName
```
String clientName
```
      The client name from the update user pool client request.
- Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolClientResult extends Object implements Serializable
  - Serialized Fields
    - userPoolClient
```
UserPoolClientType userPoolClient
```
      The user pool client value from the response from the server when an update user pool client request is made.
- Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool you want to update.
    - policies
```
UserPoolPolicyType policies
```
      A container with the policies you wish to update in a user pool.
    - lambdaConfig
```
LambdaConfigType lambdaConfig
```
      The AWS Lambda configuration information from the request to update the user pool.
    - autoVerifiedAttributes
```
List<E> autoVerifiedAttributes
```
      The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    - smsVerificationMessage
```
String smsVerificationMessage
```
      A container with information about the SMS verification message.
    - emailVerificationMessage
```
String emailVerificationMessage
```
      The contents of the email verification message.
    - emailVerificationSubject
```
String emailVerificationSubject
```
      The subject of the email verfication message
    - smsAuthenticationMessage
```
String smsAuthenticationMessage
```
      The contents of the SMS authentication message.
    - mfaConfiguration
```
String mfaConfiguration
```
      Can be one of the following values:
      
      OFF - MFA tokens are not required and cannot be specified during user registration.
      
      ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
      
      OPTIONAL - Users have the option when registering to create an MFA token.
- Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolResult extends Object implements Serializable
- Class com.amazonaws.services.cognitoidp.model.UserLambdaValidationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.UsernameExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitoidp.model.UserPoolClientDescription extends Object implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool where you want to describe the user pool client.
    - clientName
```
String clientName
```
      The client name from the user pool client description.
- Class com.amazonaws.services.cognitoidp.model.UserPoolClientType extends Object implements Serializable
  - Serialized Fields
    - userPoolId
```
String userPoolId
```
      The user pool ID for the user pool client.
    - clientName
```
String clientName
```
      The client name from the user pool request of the client type.
    - clientId
```
String clientId
```
      The ID of the client associated with the user pool.
    - clientSecret
```
String clientSecret
```
      The client secret from the user pool request of the client type.
    - lastModifiedDate
```
Date lastModifiedDate
```
      The last modified date from the user pool request of the client type.
    - creationDate
```
Date creationDate
```
      The creation date from the user pool request of the client type.
- Class com.amazonaws.services.cognitoidp.model.UserPoolDescriptionType extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID in a user pool description.
    - name
```
String name
```
      The name in a user pool description.
    - lambdaConfig
```
LambdaConfigType lambdaConfig
```
      The AWS Lambda configuration information in a user pool description.
    - status
```
String status
```
      The user pool status in a user pool description.
    - lastModifiedDate
```
Date lastModifiedDate
```
      The last modified date in a user pool description.
    - creationDate
```
Date creationDate
```
      The creation date in a user pool description.
- Class com.amazonaws.services.cognitoidp.model.UserPoolPolicyType extends Object implements Serializable
  - Serialized Fields
    - passwordPolicy
```
PasswordPolicyType passwordPolicy
```
      A container with information about the user pool password policy.
- Class com.amazonaws.services.cognitoidp.model.UserPoolType extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the user pool.
    - name
```
String name
```
      The name of the user pool.
    - policies
```
UserPoolPolicyType policies
```
      A container describing the policies associated with a user pool.
    - lambdaConfig
```
LambdaConfigType lambdaConfig
```
      A container describing the AWS Lambda triggers associated with a user pool.
    - status
```
String status
```
      The status of a user pool.
    - lastModifiedDate
```
Date lastModifiedDate
```
      The last modified date of a user pool.
    - creationDate
```
Date creationDate
```
      The creation date of a user pool.
    - schemaAttributes
```
List<E> schemaAttributes
```
      A container with the schema attributes of a user pool.
    - autoVerifiedAttributes
```
List<E> autoVerifiedAttributes
```
      Specifies the attributes that are auto-verified in a user pool.
    - aliasAttributes
```
List<E> aliasAttributes
```
      Specifies the attributes that are aliased in a user pool.
    - smsVerificationMessage
```
String smsVerificationMessage
```
      The contents of the SMS verification message.
    - emailVerificationMessage
```
String emailVerificationMessage
```
      The contents of the email verification message.
    - emailVerificationSubject
```
String emailVerificationSubject
```
      The subject of the email verification message.
    - smsAuthenticationMessage
```
String smsAuthenticationMessage
```
      The contents of the SMS authentication message.
    - mfaConfiguration
```
String mfaConfiguration
```
      Can be one of the following values:
      
      OFF - MFA tokens are not required and cannot be specified during user registration.
      
      ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
      
      OPTIONAL - Users have the option when registering to create an MFA token.
    - estimatedNumberOfUsers
```
Integer estimatedNumberOfUsers
```
      A number estimating the size of the user pool.
- Class com.amazonaws.services.cognitoidp.model.UserType extends Object implements Serializable
  - Serialized Fields
    - username
```
String username
```
      The user name of the user you wish to describe.
    - attributes
```
List<E> attributes
```
      A container with information about the user type attributes.
    - userCreateDate
```
Date userCreateDate
```
      The creation date of the user.
    - userLastModifiedDate
```
Date userLastModifiedDate
```
      The last modified date of the user.
    - enabled
```
Boolean enabled
```
      Specifies whether the user is enabled.
    - userStatus
```
String userStatus
```
      The user status. Can be one of the following:
      
      UNCONFIRMED - User has been created but not confirmed.
      
      CONFIRMED - User has been confirmed.
      
      ARCHIVED - User is no longer active.
      
      COMPROMISED - User is disabled due to a potential security threat.
      
      UNKNOWN - User status is not known.
- Class com.amazonaws.services.cognitoidp.model.VerifyUserAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      Represents the access token of the request to verify user attributes.
    - attributeName
```
String attributeName
```
      The attribute name in the request to verify user attributes.
    - code
```
String code
```
      The verification code in the request to verify user attributes.
- Class com.amazonaws.services.cognitoidp.model.VerifyUserAttributeResult extends Object implements Serializable
Package com.amazonaws.services.cognitosync.model
- Class com.amazonaws.services.cognitosync.model.AlreadyStreamedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.BulkPublishRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
- Class com.amazonaws.services.cognitosync.model.BulkPublishResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
- Class com.amazonaws.services.cognitosync.model.CognitoStreams extends Object implements Serializable
  - Serialized Fields
    - streamName
```
String streamName
```
      The name of the Cognito stream to receive updates. This stream must be in the developers account and in the same region as the identity pool.
    - roleArn
```
String roleArn
```
      The ARN of the role Amazon Cognito can assume in order to publish to the stream. This role must grant access to Amazon Cognito (cognito-sync) to invoke PutRecord on your Cognito stream.
    - streamingStatus
```
String streamingStatus
```
      Status of the Cognito streams. Valid values are:
      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.
- Class com.amazonaws.services.cognitosync.model.ConcurrentModificationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.Dataset extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - datasetName
```
String datasetName
```
      A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
    - creationDate
```
Date creationDate
```
      Date on which the dataset was created.
    - lastModifiedDate
```
Date lastModifiedDate
```
      Date when the dataset was last modified.
    - lastModifiedBy
```
String lastModifiedBy
```
      The device that made the last change to this dataset.
    - dataStorage
```
Long dataStorage
```
      Total size in bytes of the records in this dataset.
    - numRecords
```
Long numRecords
```
      Number of records in this dataset.
- Class com.amazonaws.services.cognitosync.model.DeleteDatasetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - datasetName
```
String datasetName
```
      A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
- Class com.amazonaws.services.cognitosync.model.DeleteDatasetResult extends Object implements Serializable
  - Serialized Fields
    - dataset
```
Dataset dataset
```
      A collection of data for an identity pool. An identity pool can have multiple datasets. A dataset is per identity and can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.
- Class com.amazonaws.services.cognitosync.model.DescribeDatasetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - datasetName
```
String datasetName
```
      A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
- Class com.amazonaws.services.cognitosync.model.DescribeDatasetResult extends Object implements Serializable
  - Serialized Fields
    - dataset
```
Dataset dataset
```
      Meta data for a collection of data for an identity. An identity can have multiple datasets. A dataset can be general or associated with a particular entity in an application (like a saved game). Datasets are automatically created if they don't exist. Data is synced by dataset, and a dataset can hold up to 1MB of key-value pairs.
- Class com.amazonaws.services.cognitosync.model.DescribeIdentityPoolUsageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
- Class com.amazonaws.services.cognitosync.model.DescribeIdentityPoolUsageResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolUsage
```
IdentityPoolUsage identityPoolUsage
```
      Information about the usage of the identity pool.
- Class com.amazonaws.services.cognitosync.model.DescribeIdentityUsageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
- Class com.amazonaws.services.cognitosync.model.DescribeIdentityUsageResult extends Object implements Serializable
  - Serialized Fields
    - identityUsage
```
IdentityUsage identityUsage
```
      Usage information for the identity.
- Class com.amazonaws.services.cognitosync.model.DuplicateRequestException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.GetBulkPublishDetailsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
- Class com.amazonaws.services.cognitosync.model.GetBulkPublishDetailsResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - bulkPublishStartTime
```
Date bulkPublishStartTime
```
      The date/time at which the last bulk publish was initiated.
    - bulkPublishCompleteTime
```
Date bulkPublishCompleteTime
```
      If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.
    - bulkPublishStatus
```
String bulkPublishStatus
```
      Status of the last bulk publish operation, valid values are:
      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.
    - failureMessage
```
String failureMessage
```
      If BulkPublishStatus is FAILED this field will contain the error message that caused the bulk publish to fail.
- Class com.amazonaws.services.cognitosync.model.GetCognitoEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      The Cognito Identity Pool ID for the request
- Class com.amazonaws.services.cognitosync.model.GetCognitoEventsResult extends Object implements Serializable
  - Serialized Fields
    - events
```
com.amazonaws.internal.SdkInternalMap<K,V> events
```
      The Cognito Events returned from the GetCognitoEvents request
- Class com.amazonaws.services.cognitosync.model.GetIdentityPoolConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
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.
- Class com.amazonaws.services.cognitosync.model.GetIdentityPoolConfigurationResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
    - pushSync
```
PushSync pushSync
```
      Options to apply to this identity pool for push synchronization.
    - cognitoStreams
```
CognitoStreams cognitoStreams
```
      Options to apply to this identity pool for Amazon Cognito streams.
- Class com.amazonaws.services.cognitosync.model.IdentityPoolUsage extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - syncSessionsCount
```
Long syncSessionsCount
```
      Number of sync sessions for the identity pool.
    - dataStorage
```
Long dataStorage
```
      Data storage information for the identity pool.
    - lastModifiedDate
```
Date lastModifiedDate
```
      Date on which the identity pool was last modified.
- Class com.amazonaws.services.cognitosync.model.IdentityUsage extends Object implements Serializable
  - Serialized Fields
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - lastModifiedDate
```
Date lastModifiedDate
```
      Date on which the identity was last modified.
    - datasetCount
```
Integer datasetCount
```
      Number of datasets for the identity.
    - dataStorage
```
Long dataStorage
```
      Total data storage for this identity.
- Class com.amazonaws.services.cognitosync.model.InternalErrorException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.InvalidConfigurationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.InvalidLambdaFunctionOutputException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.InvalidParameterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.LambdaThrottledException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.ListDatasetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - nextToken
```
String nextToken
```
      A pagination token for obtaining the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to be returned.
- Class com.amazonaws.services.cognitosync.model.ListDatasetsResult extends Object implements Serializable
  - Serialized Fields
    - datasets
```
com.amazonaws.internal.SdkInternalList<T> datasets
```
      A set of datasets.
    - count
```
Integer count
```
      Number of datasets returned.
    - nextToken
```
String nextToken
```
      A pagination token for obtaining the next page of results.
- Class com.amazonaws.services.cognitosync.model.ListIdentityPoolUsageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      A pagination token for obtaining the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to be returned.
- Class com.amazonaws.services.cognitosync.model.ListIdentityPoolUsageResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolUsages
```
com.amazonaws.internal.SdkInternalList<T> identityPoolUsages
```
      Usage information for the identity pools.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to be returned.
    - count
```
Integer count
```
      Total number of identities for the identity pool.
    - nextToken
```
String nextToken
```
      A pagination token for obtaining the next page of results.
- Class com.amazonaws.services.cognitosync.model.ListRecordsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - datasetName
```
String datasetName
```
      A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
    - lastSyncCount
```
Long lastSyncCount
```
      The last server sync count for this record.
    - nextToken
```
String nextToken
```
      A pagination token for obtaining the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to be returned.
    - syncSessionToken
```
String syncSessionToken
```
      A token containing a session ID, identity ID, and expiration.
- Class com.amazonaws.services.cognitosync.model.ListRecordsResult extends Object implements Serializable
  - Serialized Fields
    - records
```
com.amazonaws.internal.SdkInternalList<T> records
```
      A list of all records.
    - nextToken
```
String nextToken
```
      A pagination token for obtaining the next page of results.
    - count
```
Integer count
```
      Total number of records.
    - datasetSyncCount
```
Long datasetSyncCount
```
      Server sync count for this dataset.
    - lastModifiedBy
```
String lastModifiedBy
```
      The user/device that made the last change to this record.
    - mergedDatasetNames
```
com.amazonaws.internal.SdkInternalList<T> mergedDatasetNames
```
      Names of merged datasets.
    - datasetExists
```
Boolean datasetExists
```
      Indicates whether the dataset exists.
    - datasetDeletedAfterRequestedSyncCount
```
Boolean datasetDeletedAfterRequestedSyncCount
```
      A boolean value specifying whether to delete the dataset locally.
    - syncSessionToken
```
String syncSessionToken
```
      A token containing a session ID, identity ID, and expiration.
- Class com.amazonaws.services.cognitosync.model.NotAuthorizedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.PushSync extends Object implements Serializable
  - Serialized Fields
    - applicationArns
```
com.amazonaws.internal.SdkInternalList<T> applicationArns
```
      List of SNS platform application ARNs that could be used by clients.
    - roleArn
```
String roleArn
```
      A role configured to allow Cognito to call SNS on behalf of the developer.
- Class com.amazonaws.services.cognitosync.model.Record extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The key for the record.
    - value
```
String value
```
      The value for the record.
    - syncCount
```
Long syncCount
```
      The server sync count for this record.
    - lastModifiedDate
```
Date lastModifiedDate
```
      The date on which the record was last modified.
    - lastModifiedBy
```
String lastModifiedBy
```
      The user/device that made the last change to this record.
    - deviceLastModifiedDate
```
Date deviceLastModifiedDate
```
      The last modified date of the client device.
- Class com.amazonaws.services.cognitosync.model.RecordPatch extends Object implements Serializable
  - Serialized Fields
    - op
```
String op
```
      An operation, either replace or remove.
    - key
```
String key
```
      The key associated with the record patch.
    - value
```
String value
```
      The value associated with the record patch.
    - syncCount
```
Long syncCount
```
      Last known server sync count for this record. Set to 0 if unknown.
    - deviceLastModifiedDate
```
Date deviceLastModifiedDate
```
      The last modified date of the client device.
- Class com.amazonaws.services.cognitosync.model.RegisterDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
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.
    - identityId
```
String identityId
```
      The unique ID for this identity.
    - platform
```
String platform
```
      The SNS platform type (e.g. GCM, SDM, APNS, APNS_SANDBOX).
    - token
```
String token
```
      The push token.
- Class com.amazonaws.services.cognitosync.model.RegisterDeviceResult extends Object implements Serializable
  - Serialized Fields
    - deviceId
```
String deviceId
```
      The unique ID generated for this device by Cognito.
- Class com.amazonaws.services.cognitosync.model.ResourceConflictException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.SetCognitoEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      The Cognito Identity Pool to use when configuring Cognito Events
    - events
```
com.amazonaws.internal.SdkInternalMap<K,V> events
```
      The events to configure
- Class com.amazonaws.services.cognitosync.model.SetIdentityPoolConfigurationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
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 pushSync
```
      Options to apply to this identity pool for push synchronization.
    - cognitoStreams
```
CognitoStreams cognitoStreams
```
      Options to apply to this identity pool for Amazon Cognito streams.
- Class com.amazonaws.services.cognitosync.model.SetIdentityPoolConfigurationResult extends Object implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito.
    - pushSync
```
PushSync pushSync
```
      Options to apply to this identity pool for push synchronization.
    - cognitoStreams
```
CognitoStreams cognitoStreams
```
      Options to apply to this identity pool for Amazon Cognito streams.
- Class com.amazonaws.services.cognitosync.model.SubscribeToDatasetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
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.
    - identityId
```
String identityId
```
      Unique ID for this identity.
    - datasetName
```
String datasetName
```
      The name of the dataset to subcribe to.
    - deviceId
```
String deviceId
```
      The unique ID generated for this device by Cognito.
- Class com.amazonaws.services.cognitosync.model.SubscribeToDatasetResult extends Object implements Serializable
- Class com.amazonaws.services.cognitosync.model.TooManyRequestsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cognitosync.model.UnsubscribeFromDatasetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
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.
    - identityId
```
String identityId
```
      Unique ID for this identity.
    - datasetName
```
String datasetName
```
      The name of the dataset from which to unsubcribe.
    - deviceId
```
String deviceId
```
      The unique ID generated for this device by Cognito.
- Class com.amazonaws.services.cognitosync.model.UnsubscribeFromDatasetResult extends Object implements Serializable
- Class com.amazonaws.services.cognitosync.model.UpdateRecordsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - identityPoolId
```
String identityPoolId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - identityId
```
String identityId
```
      A name-spaced GUID (for example, us-east-1:23EC4050-6AEA-7089-A2DD-08002EXAMPLE) created by Amazon Cognito. GUID generation is unique within a region.
    - datasetName
```
String datasetName
```
      A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).
    - deviceId
```
String deviceId
```
      The unique ID generated for this device by Cognito.
    - recordPatches
```
com.amazonaws.internal.SdkInternalList<T> recordPatches
```
      A list of patch operations.
    - syncSessionToken
```
String syncSessionToken
```
      The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.
    - clientContext
```
String clientContext
```
      Intended to supply a device ID that will populate the lastModifiedBy field referenced in other methods. The ClientContext field is not yet implemented.
- Class com.amazonaws.services.cognitosync.model.UpdateRecordsResult extends Object implements Serializable
  - Serialized Fields
    - records
```
com.amazonaws.internal.SdkInternalList<T> records
```
      A list of records that have been updated.
Package com.amazonaws.services.config.model
- Class com.amazonaws.services.config.model.Compliance extends Object implements Serializable
  - Serialized Fields
    - complianceType
```
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.
      
      AWS Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the AWS resource or Config rule.
      
      For the Compliance data type, AWS Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. AWS Config does not support the NOT_APPLICABLE value for the Compliance data type.
    - complianceContributorCount
```
ComplianceContributorCount complianceContributorCount
```
      The number of AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a maximum number.
- Class com.amazonaws.services.config.model.ComplianceByConfigRule extends Object implements Serializable
  - Serialized Fields
    - configRuleName
```
String configRuleName
```
      The name of the AWS Config rule.
    - compliance
```
Compliance compliance
```
      Indicates whether the AWS Config rule is compliant.
- Class com.amazonaws.services.config.model.ComplianceByResource extends Object implements Serializable
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The type of the AWS resource that was evaluated.
    - resourceId
```
String resourceId
```
      The ID of the AWS resource that was evaluated.
    - compliance
```
Compliance compliance
```
      Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.
- Class com.amazonaws.services.config.model.ComplianceContributorCount extends Object implements Serializable
  - Serialized Fields
    - cappedCount
```
Integer cappedCount
```
      The number of AWS resources or AWS Config rules responsible for the current compliance of the item.
    - capExceeded
```
Boolean capExceeded
```
      Indicates whether the maximum count is reached.
- Class com.amazonaws.services.config.model.ComplianceSummary extends Object implements Serializable
  - Serialized Fields
    - compliantResourceCount
```
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.
    - nonCompliantResourceCount
```
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.
    - complianceSummaryTimestamp
```
Date complianceSummaryTimestamp
```
      The time that AWS Config created the compliance summary.
- Class com.amazonaws.services.config.model.ComplianceSummaryByResourceType extends Object implements Serializable
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The type of AWS resource.
    - complianceSummary
```
ComplianceSummary complianceSummary
```
      The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each compliance.
- Class com.amazonaws.services.config.model.ConfigExportDeliveryInfo extends Object implements Serializable
  - Serialized Fields
    - lastStatus
```
String lastStatus
```
      Status of the last attempted delivery.
    - lastErrorCode
```
String lastErrorCode
```
      The error code from the last attempted delivery.
    - lastErrorMessage
```
String lastErrorMessage
```
      The error message from the last attempted delivery.
    - lastAttemptTime
```
Date lastAttemptTime
```
      The time of the last attempted delivery.
    - lastSuccessfulTime
```
Date lastSuccessfulTime
```
      The time of the last successful delivery.
    - nextDeliveryTime
```
Date nextDeliveryTime
```
      The time that the next delivery occurs.
- Class com.amazonaws.services.config.model.ConfigRule extends Object implements Serializable
  - Serialized Fields
    - configRuleName
```
String configRuleName
```
      The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
    - configRuleArn
```
String configRuleArn
```
      The Amazon Resource Name (ARN) of the AWS Config rule.
    - configRuleId
```
String configRuleId
```
      The ID of the AWS Config rule.
    - description
```
String description
```
      The description that you provide for the AWS Config rule.
    - scope
```
Scope scope
```
      Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
    - source
```
Source source
```
      Provides the rule owner (AWS or customer), the rule identifier, and the events that cause the function to evaluate your AWS resources.
    - inputParameters
```
String inputParameters
```
      A string in JSON format that is passed to the AWS Config rule Lambda function.
    - maximumExecutionFrequency
```
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.
    - configRuleState
```
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.
- Class com.amazonaws.services.config.model.ConfigRuleEvaluationStatus extends Object implements Serializable
  - Serialized Fields
    - configRuleName
```
String configRuleName
```
      The name of the AWS Config rule.
    - configRuleArn
```
String configRuleArn
```
      The Amazon Resource Name (ARN) of the AWS Config rule.
    - configRuleId
```
String configRuleId
```
      The ID of the AWS Config rule.
    - lastSuccessfulInvocationTime
```
Date lastSuccessfulInvocationTime
```
      The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.
    - lastFailedInvocationTime
```
Date lastFailedInvocationTime
```
      The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources.
    - lastSuccessfulEvaluationTime
```
Date lastSuccessfulEvaluationTime
```
      The time that AWS Config last successfully evaluated your AWS resources against the rule.
    - lastFailedEvaluationTime
```
Date lastFailedEvaluationTime
```
      The time that AWS Config last failed to evaluate your AWS resources against the rule.
    - firstActivatedTime
```
Date firstActivatedTime
```
      The time that you first activated the AWS Config rule.
    - lastErrorCode
```
String lastErrorCode
```
      The error code that AWS Config returned when the rule last failed.
    - lastErrorMessage
```
String lastErrorMessage
```
      The error message that AWS Config returned when the rule last failed.
    - firstEvaluationStarted
```
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.
- Class com.amazonaws.services.config.model.ConfigSnapshotDeliveryProperties extends Object implements Serializable
  - Serialized Fields
    - deliveryFrequency
```
String deliveryFrequency
```
      The frequency with which a AWS Config recurringly delivers configuration snapshots.
- Class com.amazonaws.services.config.model.ConfigStreamDeliveryInfo extends Object implements Serializable
  - Serialized Fields
    - lastStatus
```
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.
    - lastErrorCode
```
String lastErrorCode
```
      The error code from the last attempted delivery.
    - lastErrorMessage
```
String lastErrorMessage
```
      The error message from the last attempted delivery.
    - lastStatusChangeTime
```
Date lastStatusChangeTime
```
      The time from the last status change.
- Class com.amazonaws.services.config.model.ConfigurationItem extends Object implements Serializable
  - Serialized Fields
    - version
```
String version
```
      The version number of the resource configuration.
    - accountId
```
String accountId
```
      The 12 digit AWS account ID associated with the resource.
    - configurationItemCaptureTime
```
Date configurationItemCaptureTime
```
      The time when the configuration recording was initiated.
    - configurationItemStatus
```
String configurationItemStatus
```
      The configuration item status.
    - configurationStateId
```
String configurationStateId
```
      An identifier that indicates the ordering of the configuration items of a resource.
    - configurationItemMD5Hash
```
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.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the resource.
    - resourceType
```
String resourceType
```
      The type of AWS resource.
    - resourceId
```
String resourceId
```
      The ID of the resource (for example., sg-xxxxxx).
    - resourceName
```
String resourceName
```
      The custom name of the resource, if available.
    - awsRegion
```
String awsRegion
```
      The region where the resource resides.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone associated with the resource.
    - resourceCreationTime
```
Date resourceCreationTime
```
      The time stamp when the resource was created.
    - tags
```
Map<K,V> tags
```
      A mapping of key value tags associated with the resource.
    - relatedEvents
```
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.
    - relationships
```
com.amazonaws.internal.SdkInternalList<T> relationships
```
      A list of related AWS resources.
    - configuration
```
String configuration
```
      The description of the resource configuration.
- Class com.amazonaws.services.config.model.ConfigurationRecorder extends Object implements Serializable
  - Serialized Fields
    - name
```
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.
    - roleARN
```
String roleARN
```
      Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.
    - recordingGroup
```
RecordingGroup recordingGroup
```
      Specifies the types of AWS resource for which AWS Config records configuration changes.
- Class com.amazonaws.services.config.model.ConfigurationRecorderStatus extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the configuration recorder.
    - lastStartTime
```
Date lastStartTime
```
      The time the recorder was last started.
    - lastStopTime
```
Date lastStopTime
```
      The time the recorder was last stopped.
    - recording
```
Boolean recording
```
      Specifies whether the recorder is currently recording or not.
    - lastStatus
```
String lastStatus
```
      The last (previous) status of the recorder.
    - lastErrorCode
```
String lastErrorCode
```
      The error code indicating that the recording failed.
    - lastErrorMessage
```
String lastErrorMessage
```
      The message indicating that the recording failed due to an error.
    - lastStatusChangeTime
```
Date lastStatusChangeTime
```
      The time when the status was last changed.
- Class com.amazonaws.services.config.model.DeleteConfigRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configRuleName
```
String configRuleName
```
      The name of the AWS Config rule that you want to delete.
- Class com.amazonaws.services.config.model.DeleteDeliveryChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deliveryChannelName
```
String deliveryChannelName
```
      The name of the delivery channel to delete.
- Class com.amazonaws.services.config.model.DeliverConfigSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deliveryChannelName
```
String deliveryChannelName
```
      The name of the delivery channel through which the snapshot is delivered.
- Class com.amazonaws.services.config.model.DeliverConfigSnapshotResult extends Object implements Serializable
  - Serialized Fields
    - configSnapshotId
```
String configSnapshotId
```
      The ID of the snapshot that is being created.
- Class com.amazonaws.services.config.model.DeliveryChannel extends Object implements Serializable
  - Serialized Fields
    - name
```
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.
    - s3BucketName
```
String s3BucketName
```
      The name of the Amazon S3 bucket used to store configuration history for the delivery channel.
    - s3KeyPrefix
```
String s3KeyPrefix
```
      The prefix for the specified Amazon S3 bucket.
    - snsTopicARN
```
String snsTopicARN
```
      The Amazon Resource Name (ARN) of the SNS topic that AWS Config delivers notifications to.
    - configSnapshotDeliveryProperties
```
ConfigSnapshotDeliveryProperties configSnapshotDeliveryProperties
```
- Class com.amazonaws.services.config.model.DeliveryChannelStatus extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the delivery channel.
    - configSnapshotDeliveryInfo
```
ConfigExportDeliveryInfo configSnapshotDeliveryInfo
```
      A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
    - configHistoryDeliveryInfo
```
ConfigExportDeliveryInfo configHistoryDeliveryInfo
```
      A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
    - configStreamDeliveryInfo
```
ConfigStreamDeliveryInfo configStreamDeliveryInfo
```
      A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
- Class com.amazonaws.services.config.model.DescribeComplianceByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configRuleNames
```
com.amazonaws.internal.SdkInternalList<T> configRuleNames
```
      Specify one or more AWS Config rule names to filter the results by rule.
    - complianceTypes
```
com.amazonaws.internal.SdkInternalList<T> complianceTypes
```
      Filters the results by compliance.
      
      The allowed values are COMPLIANT, NON_COMPLIANT , and INSUFFICIENT_DATA.
    - nextToken
```
String nextToken
```
      The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.DescribeComplianceByConfigRuleResult extends Object implements Serializable
  - Serialized Fields
    - complianceByConfigRules
```
com.amazonaws.internal.SdkInternalList<T> complianceByConfigRules
```
      Indicates whether each of the specified AWS Config rules is compliant.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.DescribeComplianceByResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceType
```
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.
    - resourceId
```
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.
    - complianceTypes
```
com.amazonaws.internal.SdkInternalList<T> complianceTypes
```
      Filters the results by compliance.
      
      The allowed values are COMPLIANT, NON_COMPLIANT , and INSUFFICIENT_DATA.
    - limit
```
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.
    - nextToken
```
String nextToken
```
      The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.DescribeComplianceByResourceResult extends Object implements Serializable
  - Serialized Fields
    - complianceByResources
```
com.amazonaws.internal.SdkInternalList<T> complianceByResources
```
      Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.DescribeConfigRuleEvaluationStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configRuleNames
```
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.
- Class com.amazonaws.services.config.model.DescribeConfigRuleEvaluationStatusResult extends Object implements Serializable
  - Serialized Fields
    - configRulesEvaluationStatus
```
com.amazonaws.internal.SdkInternalList<T> configRulesEvaluationStatus
```
      Status information about your AWS managed Config rules.
- Class com.amazonaws.services.config.model.DescribeConfigRulesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configRuleNames
```
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.
    - nextToken
```
String nextToken
```
      The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.DescribeConfigRulesResult extends Object implements Serializable
  - Serialized Fields
    - configRules
```
com.amazonaws.internal.SdkInternalList<T> configRules
```
      The details about your AWS Config rules.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.DescribeConfigurationRecordersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationRecorderNames
```
com.amazonaws.internal.SdkInternalList<T> configurationRecorderNames
```
      A list of configuration recorder names.
- Class com.amazonaws.services.config.model.DescribeConfigurationRecordersResult extends Object implements Serializable
  - Serialized Fields
    - configurationRecorders
```
com.amazonaws.internal.SdkInternalList<T> configurationRecorders
```
      A list that contains the descriptions of the specified configuration recorders.
- Class com.amazonaws.services.config.model.DescribeConfigurationRecorderStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationRecorderNames
```
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.
- Class com.amazonaws.services.config.model.DescribeConfigurationRecorderStatusResult extends Object implements Serializable
  - Serialized Fields
    - configurationRecordersStatus
```
com.amazonaws.internal.SdkInternalList<T> configurationRecordersStatus
```
      A list that contains status of the specified recorders.
- Class com.amazonaws.services.config.model.DescribeDeliveryChannelsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deliveryChannelNames
```
com.amazonaws.internal.SdkInternalList<T> deliveryChannelNames
```
      A list of delivery channel names.
- Class com.amazonaws.services.config.model.DescribeDeliveryChannelsResult extends Object implements Serializable
  - Serialized Fields
    - deliveryChannels
```
com.amazonaws.internal.SdkInternalList<T> deliveryChannels
```
      A list that contains the descriptions of the specified delivery channel.
- Class com.amazonaws.services.config.model.DescribeDeliveryChannelStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deliveryChannelNames
```
com.amazonaws.internal.SdkInternalList<T> deliveryChannelNames
```
      A list of delivery channel names.
- Class com.amazonaws.services.config.model.DescribeDeliveryChannelStatusResult extends Object implements Serializable
  - Serialized Fields
    - deliveryChannelsStatus
```
com.amazonaws.internal.SdkInternalList<T> deliveryChannelsStatus
```
      A list that contains the status of a specified delivery channel.
- Class com.amazonaws.services.config.model.Evaluation extends Object implements Serializable
  - Serialized Fields
    - complianceResourceType
```
String complianceResourceType
```
      The type of AWS resource that was evaluated.
    - complianceResourceId
```
String complianceResourceId
```
      The ID of the AWS resource that was evaluated.
    - complianceType
```
String complianceType
```
      Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.
      
      For the Evaluation data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for this data type.
      
      Similarly, AWS Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an AWS Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to AWS Config.
    - annotation
```
String annotation
```
      Supplementary information about how the evaluation determined the compliance.
    - orderingTimestamp
```
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.
- Class com.amazonaws.services.config.model.EvaluationResult extends Object implements Serializable
  - Serialized Fields
    - evaluationResultIdentifier
```
EvaluationResultIdentifier evaluationResultIdentifier
```
      Uniquely identifies the evaluation result.
    - complianceType
```
String complianceType
```
      Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.
      
      For the EvaluationResult data type, AWS Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. AWS Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.
    - resultRecordedTime
```
Date resultRecordedTime
```
      The time when AWS Config recorded the evaluation result.
    - configRuleInvokedTime
```
Date configRuleInvokedTime
```
      The time when the AWS Config rule evaluated the AWS resource.
    - annotation
```
String annotation
```
      Supplementary information about how the evaluation determined the compliance.
    - resultToken
```
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.
- Class com.amazonaws.services.config.model.EvaluationResultIdentifier extends Object implements Serializable
  - Serialized Fields
    - evaluationResultQualifier
```
EvaluationResultQualifier evaluationResultQualifier
```
      Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated resource.
    - orderingTimestamp
```
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.
- Class com.amazonaws.services.config.model.EvaluationResultQualifier extends Object implements Serializable
  - Serialized Fields
    - configRuleName
```
String configRuleName
```
      The name of the AWS Config rule that was used in the evaluation.
    - resourceType
```
String resourceType
```
      The type of AWS resource that was evaluated.
    - resourceId
```
String resourceId
```
      The ID of the evaluated AWS resource.
- Class com.amazonaws.services.config.model.GetComplianceDetailsByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configRuleName
```
String configRuleName
```
      The name of the AWS Config rule for which you want compliance information.
    - complianceTypes
```
com.amazonaws.internal.SdkInternalList<T> complianceTypes
```
      Filters the results by compliance.
      
      The allowed values are COMPLIANT, NON_COMPLIANT , and NOT_APPLICABLE.
    - limit
```
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.
    - nextToken
```
String nextToken
```
      The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.GetComplianceDetailsByConfigRuleResult extends Object implements Serializable
  - Serialized Fields
    - evaluationResults
```
com.amazonaws.internal.SdkInternalList<T> evaluationResults
```
      Indicates whether the AWS resource complies with the specified AWS Config rule.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.GetComplianceDetailsByResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The type of the AWS resource for which you want compliance information.
    - resourceId
```
String resourceId
```
      The ID of the AWS resource for which you want compliance information.
    - complianceTypes
```
com.amazonaws.internal.SdkInternalList<T> complianceTypes
```
      Filters the results by compliance.
      
      The allowed values are COMPLIANT, NON_COMPLIANT , and NOT_APPLICABLE.
    - nextToken
```
String nextToken
```
      The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.GetComplianceDetailsByResourceResult extends Object implements Serializable
  - Serialized Fields
    - evaluationResults
```
com.amazonaws.internal.SdkInternalList<T> evaluationResults
```
      Indicates whether the specified AWS resource complies each AWS Config rule.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.GetComplianceSummaryByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.config.model.GetComplianceSummaryByConfigRuleResult extends Object implements Serializable
  - Serialized Fields
    - complianceSummary
```
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.
- Class com.amazonaws.services.config.model.GetComplianceSummaryByResourceTypeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceTypes
```
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.
- Class com.amazonaws.services.config.model.GetComplianceSummaryByResourceTypeResult extends Object implements Serializable
  - Serialized Fields
    - complianceSummariesByResourceType
```
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.
- Class com.amazonaws.services.config.model.GetResourceConfigHistoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The resource type.
    - resourceId
```
String resourceId
```
      The ID of the resource (for example., sg-xxxxxx).
    - laterTime
```
Date laterTime
```
      The time stamp that indicates a later time. If not specified, current time is taken.
    - earlierTime
```
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.
    - chronologicalOrder
```
String chronologicalOrder
```
      The chronological order for configuration items listed. By default the results are listed in reverse chronological order.
    - limit
```
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.
    - nextToken
```
String nextToken
```
      The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.GetResourceConfigHistoryResult extends Object implements Serializable
  - Serialized Fields
    - configurationItems
```
com.amazonaws.internal.SdkInternalList<T> configurationItems
```
      A list that contains the configuration history of one or more resources.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.InsufficientDeliveryPolicyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InsufficientPermissionsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidConfigurationRecorderNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidDeliveryChannelNameException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidLimitException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidParameterValueException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidRecordingGroupException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidResultTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidRoleException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidS3KeyPrefixException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidSNSTopicARNException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.InvalidTimeRangeException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.LastDeliveryChannelDeleteFailedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.ListDiscoveredResourcesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The type of resources that you want AWS Config to list in the response.
    - resourceIds
```
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.
    - resourceName
```
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.
    - limit
```
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.
    - includeDeletedResources
```
Boolean includeDeletedResources
```
      Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.
    - nextToken
```
String nextToken
```
      The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.ListDiscoveredResourcesResult extends Object implements Serializable
  - Serialized Fields
    - resourceIdentifiers
```
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.
    - nextToken
```
String nextToken
```
      The string that you use in a subsequent request to get the next page of results in a paginated response.
- Class com.amazonaws.services.config.model.MaxNumberOfConfigRulesExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.MaxNumberOfConfigurationRecordersExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.MaxNumberOfDeliveryChannelsExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.NoAvailableConfigurationRecorderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.NoAvailableDeliveryChannelException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.NoRunningConfigurationRecorderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.NoSuchBucketException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.NoSuchConfigRuleException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.NoSuchConfigurationRecorderException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.NoSuchDeliveryChannelException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.PutConfigRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configRule
```
ConfigRule configRule
```
- Class com.amazonaws.services.config.model.PutConfigurationRecorderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationRecorder
```
ConfigurationRecorder configurationRecorder
```
      The configuration recorder object that records each configuration change made to the resources.
- Class com.amazonaws.services.config.model.PutDeliveryChannelRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - deliveryChannel
```
DeliveryChannel deliveryChannel
```
      The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
- Class com.amazonaws.services.config.model.PutEvaluationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - evaluations
```
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.
    - resultToken
```
String resultToken
```
      An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation
- Class com.amazonaws.services.config.model.PutEvaluationsResult extends Object implements Serializable
  - Serialized Fields
    - failedEvaluations
```
com.amazonaws.internal.SdkInternalList<T> failedEvaluations
```
      Requests that failed because of a client or server error.
- Class com.amazonaws.services.config.model.RecordingGroup extends Object implements Serializable
  - Serialized Fields
    - allSupported
```
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.
    - includeGlobalResourceTypes
```
Boolean includeGlobalResourceTypes
```
      Specifies whether AWS Config includes all supported types of global resources (for example, IAM 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.
      
      The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.
    - resourceTypes
```
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.
- Class com.amazonaws.services.config.model.Relationship extends Object implements Serializable
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The resource type of the related resource.
    - resourceId
```
String resourceId
```
      The ID of the related resource (for example, sg-xxxxxx).
    - resourceName
```
String resourceName
```
      The custom name of the related resource, if available.
    - relationshipName
```
String relationshipName
```
      The type of relationship with the related resource.
- Class com.amazonaws.services.config.model.ResourceIdentifier extends Object implements Serializable
  - Serialized Fields
    - resourceType
```
String resourceType
```
      The type of resource.
    - resourceId
```
String resourceId
```
      The ID of the resource (for example., sg-xxxxxx).
    - resourceName
```
String resourceName
```
      The custom name of the resource (if available).
    - resourceDeletionTime
```
Date resourceDeletionTime
```
      The time that the resource was deleted.
- Class com.amazonaws.services.config.model.ResourceInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.ResourceNotDiscoveredException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.config.model.Scope extends Object implements Serializable
  - Serialized Fields
    - complianceResourceTypes
```
com.amazonaws.internal.SdkInternalList<T> complianceResourceTypes
```
      The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.
    - tagKey
```
String tagKey
```
      The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.
    - tagValue
```
String tagValue
```
      The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.
    - complianceResourceId
```
String complianceResourceId
```
      The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.
- Class com.amazonaws.services.config.model.Source extends Object implements Serializable
  - Serialized Fields
    - owner
```
String owner
```
      Indicates whether AWS or the customer owns and manages the AWS Config rule.
    - sourceIdentifier
```
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.
    - sourceDetails
```
com.amazonaws.internal.SdkInternalList<T> sourceDetails
```
      Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.
- Class com.amazonaws.services.config.model.SourceDetail extends Object implements Serializable
  - Serialized Fields
    - eventSource
```
String eventSource
```
      The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
    - messageType
```
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.
- Class com.amazonaws.services.config.model.StartConfigurationRecorderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationRecorderName
```
String configurationRecorderName
```
      The name of the recorder object that records each configuration change made to the resources.
- Class com.amazonaws.services.config.model.StopConfigurationRecorderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - configurationRecorderName
```
String configurationRecorderName
```
      The name of the recorder object that records each configuration change made to the resources.
- Class com.amazonaws.services.config.model.ValidationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.databasemigrationservice.model
- Class com.amazonaws.services.databasemigrationservice.model.AccessDeniedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.AccountQuota extends Object implements Serializable
  - Serialized Fields
    - accountQuotaName
```
String accountQuotaName
```
      The name of the AWS DMS quota for this AWS account.
    - used
```
Long used
```
      The amount currently used toward the quota maximum.
    - max
```
Long max
```
      The maximum allowed value for the quota.
- Class com.amazonaws.services.databasemigrationservice.model.AddTagsToResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be added to. AWS DMS resources include a replication instance, endpoint, and a replication task.
    - tags
```
List<E> tags
```
      The tag to be assigned to the DMS resource.
- Class com.amazonaws.services.databasemigrationservice.model.AddTagsToResourceResult extends Object implements Serializable
- Class com.amazonaws.services.databasemigrationservice.model.AvailabilityZone extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the availability zone.
- Class com.amazonaws.services.databasemigrationservice.model.Connection extends Object implements Serializable
  - Serialized Fields
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance.
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - status
```
String status
```
      The connection status.
    - lastFailureMessage
```
String lastFailureMessage
```
      The error message when the connection last failed.
    - endpointIdentifier
```
String endpointIdentifier
```
      The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
    - replicationInstanceIdentifier
```
String replicationInstanceIdentifier
```
      The replication instance identifier. This parameter is stored as a lowercase string.
- Class com.amazonaws.services.databasemigrationservice.model.CreateEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointIdentifier
```
String endpointIdentifier
```
      The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
    - endpointType
```
String endpointType
```
      The type of endpoint.
    - engineName
```
String engineName
```
      The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, SQLSERVER.
    - username
```
String username
```
      The user name to be used to login to the endpoint database.
    - password
```
String password
```
      The password to be used to login to the endpoint database.
    - serverName
```
String serverName
```
      The name of the server where the endpoint database resides.
    - port
```
Integer port
```
      The port used by the endpoint database.
    - databaseName
```
String databaseName
```
      The name of the endpoint database.
    - extraConnectionAttributes
```
String extraConnectionAttributes
```
      Additional attributes associated with the connection.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS 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.
    - tags
```
List<E> tags
```
      Tags to be added to the endpoint.
- Class com.amazonaws.services.databasemigrationservice.model.CreateEndpointResult extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
Endpoint endpoint
```
      The endpoint that was created.
- Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationInstanceIdentifier
```
String replicationInstanceIdentifier
```
      The replication instance identifier. This parameter is stored as a lowercase string.
      
      Constraints:
      
      Must contain from 1 to 63 alphanumeric characters or hyphens.
      
      First character must be a letter.
      
      Cannot end with a hyphen or contain two consecutive hyphens.
      
      Example: myrepinstance
    - allocatedStorage
```
Integer allocatedStorage
```
      The amount of storage (in gigabytes) to be initially allocated for the replication instance.
    - replicationInstanceClass
```
String replicationInstanceClass
```
      The compute and memory capacity of the replication instance as specified by the replication instance class.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - availabilityZone
```
String availabilityZone
```
      The EC2 Availability Zone that the replication instance will be created in.
      
      Default: A random, system-chosen Availability Zone in the endpoint's region.
      
      Example: us-east-1d
    - replicationSubnetGroupIdentifier
```
String replicationSubnetGroupIdentifier
```
      A subnet group to associate with the replication instance.
    - preferredMaintenanceWindow
```
String preferredMaintenanceWindow
```
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
      
      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.
      
      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
      
      Constraints: Minimum 30-minute window.
    - engineVersion
```
String engineVersion
```
      The engine version number of the replication instance.
    - autoMinorVersionUpgrade
```
Boolean autoMinorVersionUpgrade
```
      Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window.
      
      Default: true
    - tags
```
List<E> tags
```
      Tags to be associated with the replication instance.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier that will be used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS 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.
    - publiclyAccessible
```
Boolean publiclyAccessible
```
      Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
- Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationInstanceResult extends Object implements Serializable
  - Serialized Fields
    - replicationInstance
```
ReplicationInstance replicationInstance
```
      The replication instance that was created.
- Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationSubnetGroupIdentifier
```
String replicationSubnetGroupIdentifier
```
      The name for the replication subnet group. This value is stored as a lowercase string.
      
      Constraints: Must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens. Must not be "default".
      
      Example: mySubnetgroup
    - replicationSubnetGroupDescription
```
String replicationSubnetGroupDescription
```
      The description for the subnet group.
    - subnetIds
```
List<E> subnetIds
```
      The EC2 subnet IDs for the subnet group.
    - tags
```
List<E> tags
```
      The tag to be assigned to the subnet group.
- Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationSubnetGroupResult extends Object implements Serializable
  - Serialized Fields
    - replicationSubnetGroup
```
ReplicationSubnetGroup replicationSubnetGroup
```
      The replication subnet group that was created.
- Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationTaskIdentifier
```
String replicationTaskIdentifier
```
      The replication task identifier.
      
      Constraints:
      
      Must contain from 1 to 63 alphanumeric characters or hyphens.
      
      First character must be a letter.
      
      Cannot end with a hyphen or contain two consecutive hyphens.
    - sourceEndpointArn
```
String sourceEndpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - targetEndpointArn
```
String targetEndpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance.
    - migrationType
```
String migrationType
```
      The migration type.
    - tableMappings
```
String tableMappings
```
      The path of the JSON file that contains the table mappings.
    - replicationTaskSettings
```
String replicationTaskSettings
```
      Settings for the task, such as target metadata settings.
    - cdcStartTime
```
Date cdcStartTime
```
      The start time for the Change Data Capture (CDC) operation.
    - tags
```
List<E> tags
```
      Tags to be added to the replication instance.
- Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationTaskResult extends Object implements Serializable
  - Serialized Fields
    - replicationTask
```
ReplicationTask replicationTask
```
      The replication task that was created.
- Class com.amazonaws.services.databasemigrationservice.model.DeleteEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- Class com.amazonaws.services.databasemigrationservice.model.DeleteEndpointResult extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
Endpoint endpoint
```
      The endpoint that was deleted.
- Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance to be deleted.
- Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationInstanceResult extends Object implements Serializable
  - Serialized Fields
    - replicationInstance
```
ReplicationInstance replicationInstance
```
      The replication instance that was deleted.
- Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationSubnetGroupIdentifier
```
String replicationSubnetGroupIdentifier
```
      The subnet group name of the replication instance.
- Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationSubnetGroupResult extends Object implements Serializable
- Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationTaskArn
```
String replicationTaskArn
```
      The Amazon Resource Name (ARN) of the replication task to be deleted.
- Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationTaskResult extends Object implements Serializable
  - Serialized Fields
    - replicationTask
```
ReplicationTask replicationTask
```
      The deleted replication task.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.databasemigrationservice.model.DescribeAccountAttributesResult extends Object implements Serializable
  - Serialized Fields
    - accountQuotas
```
List<E> accountQuotas
```
      Account quota information.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeConnectionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      The filters applied to the connection.
      
      Valid filter names: endpoint-arn | replication-instance-arn
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeConnectionsResult extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    - connections
```
List<E> connections
```
      A description of the connections.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      Filters applied to the describe action.
      
      Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointsResult extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    - endpoints
```
List<E> endpoints
```
      Endpoint description.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointTypesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      Filters applied to the describe action.
      
      Valid filter names: engine-name | endpoint-type
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeEndpointTypesResult extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    - supportedEndpointTypes
```
List<E> supportedEndpointTypes
```
      The type of endpoints that are supported.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeOrderableReplicationInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeOrderableReplicationInstancesResult extends Object implements Serializable
  - Serialized Fields
    - orderableReplicationInstances
```
List<E> orderableReplicationInstances
```
      The order-able replication instances available.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeRefreshSchemasStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeRefreshSchemasStatusResult extends Object implements Serializable
  - Serialized Fields
    - refreshSchemasStatus
```
RefreshSchemasStatus refreshSchemasStatus
```
      The status of the schema.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      Filters applied to the describe action.
      
      Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationInstancesResult extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    - replicationInstances
```
List<E> replicationInstances
```
      The replication instances described.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      Filters applied to the describe action.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationSubnetGroupsResult extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    - replicationSubnetGroups
```
List<E> replicationSubnetGroups
```
      A description of the replication subnet groups.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
List<E> filters
```
      Filters applied to the describe action.
      
      Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationTasksResult extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    - replicationTasks
```
List<E> replicationTasks
```
      A description of the replication tasks.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeSchemasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeSchemasResult extends Object implements Serializable
  - Serialized Fields
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
    - schemas
```
List<E> schemas
```
      The described schema.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeTableStatisticsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationTaskArn
```
String replicationTaskArn
```
      The Amazon Resource Name (ARN) of the replication task.
    - maxRecords
```
Integer maxRecords
```
      The maximum number of records to include in the response. If more records exist than the specified 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.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.DescribeTableStatisticsResult extends Object implements Serializable
  - Serialized Fields
    - replicationTaskArn
```
String replicationTaskArn
```
      The Amazon Resource Name (ARN) of the replication task.
    - tableStatistics
```
List<E> tableStatistics
```
      The table statistics.
    - marker
```
String marker
```
      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- Class com.amazonaws.services.databasemigrationservice.model.Endpoint extends Object implements Serializable
  - Serialized Fields
    - endpointIdentifier
```
String endpointIdentifier
```
      The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
    - endpointType
```
String endpointType
```
      The type of endpoint.
    - engineName
```
String engineName
```
      The database engine name.
    - username
```
String username
```
      The user name used to connect to the endpoint.
    - serverName
```
String serverName
```
      The name of the server at the endpoint.
    - port
```
Integer port
```
      The port value used to access the endpoint.
    - databaseName
```
String databaseName
```
      The name of the database at the endpoint.
    - extraConnectionAttributes
```
String extraConnectionAttributes
```
      Additional connection attributes used to connect to the endpoint.
    - status
```
String status
```
      The status of the endpoint.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS 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.
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- Class com.amazonaws.services.databasemigrationservice.model.Filter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the filter.
    - values
```
List<E> values
```
      The filter value.
- Class com.amazonaws.services.databasemigrationservice.model.InsufficientResourceCapacityException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.InvalidResourceStateException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.InvalidSubnetException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.KMSKeyNotAccessibleException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.
- Class com.amazonaws.services.databasemigrationservice.model.ListTagsForResourceResult extends Object implements Serializable
  - Serialized Fields
    - tagList
```
List<E> tagList
```
      A list of tags for the resource.
- Class com.amazonaws.services.databasemigrationservice.model.ModifyEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - endpointIdentifier
```
String endpointIdentifier
```
      The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.
    - endpointType
```
String endpointType
```
      The type of endpoint.
    - engineName
```
String engineName
```
      The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES.
    - username
```
String username
```
      The user name to be used to login to the endpoint database.
    - password
```
String password
```
      The password to be used to login to the endpoint database.
    - serverName
```
String serverName
```
      The name of the server where the endpoint database resides.
    - port
```
Integer port
```
      The port used by the endpoint database.
    - databaseName
```
String databaseName
```
      The name of the endpoint database.
    - extraConnectionAttributes
```
String extraConnectionAttributes
```
      Additional attributes associated with the connection.
- Class com.amazonaws.services.databasemigrationservice.model.ModifyEndpointResult extends Object implements Serializable
  - Serialized Fields
    - endpoint
```
Endpoint endpoint
```
      The modified endpoint.
- Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance.
    - allocatedStorage
```
Integer allocatedStorage
```
      The amount of storage (in gigabytes) to be allocated for the replication instance.
    - applyImmediately
```
Boolean applyImmediately
```
      Indicates whether the changes should be applied immediately or during the next maintenance window.
    - replicationInstanceClass
```
String replicationInstanceClass
```
      The compute and memory capacity of the replication instance.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - preferredMaintenanceWindow
```
String preferredMaintenanceWindow
```
      The weekly time range (in UTC) during which system maintenance can occur, which might result in an outage. Changing this parameter does not result in an outage, except in the following situation, and the change is asynchronously applied as soon as possible. If moving this window to the current time, there must be at least 30 minutes between the current time and end of the window to ensure pending changes are applied.
      
      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
    - engineVersion
```
String engineVersion
```
      The engine version number of the replication instance.
    - allowMajorVersionUpgrade
```
Boolean allowMajorVersionUpgrade
```
      Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible.
      
      Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the replication instance's current version.
    - autoMinorVersionUpgrade
```
Boolean autoMinorVersionUpgrade
```
      Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to true during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version.
    - replicationInstanceIdentifier
```
String replicationInstanceIdentifier
```
      The replication instance identifier. This parameter is stored as a lowercase string.
- Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationInstanceResult extends Object implements Serializable
  - Serialized Fields
    - replicationInstance
```
ReplicationInstance replicationInstance
```
      The modified replication instance.
- Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationSubnetGroupIdentifier
```
String replicationSubnetGroupIdentifier
```
      The name of the replication instance subnet group.
    - replicationSubnetGroupDescription
```
String replicationSubnetGroupDescription
```
      The description of the replication instance subnet group.
    - subnetIds
```
List<E> subnetIds
```
      A list of subnet IDs.
- Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationSubnetGroupResult extends Object implements Serializable
  - Serialized Fields
    - replicationSubnetGroup
```
ReplicationSubnetGroup replicationSubnetGroup
```
      The modified replication subnet group.
- Class com.amazonaws.services.databasemigrationservice.model.OrderableReplicationInstance extends Object implements Serializable
  - Serialized Fields
    - engineVersion
```
String engineVersion
```
      The version of the replication engine.
    - replicationInstanceClass
```
String replicationInstanceClass
```
      The compute and memory capacity of the replication instance.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - storageType
```
String storageType
```
      The type of storage used by the replication instance.
    - minAllocatedStorage
```
Integer minAllocatedStorage
```
      The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
    - maxAllocatedStorage
```
Integer maxAllocatedStorage
```
      The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.
    - defaultAllocatedStorage
```
Integer defaultAllocatedStorage
```
      The default amount of storage (in gigabytes) that is allocated for the replication instance.
    - includedAllocatedStorage
```
Integer includedAllocatedStorage
```
      The amount of storage (in gigabytes) that is allocated for the replication instance.
- Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance.
- Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasResult extends Object implements Serializable
  - Serialized Fields
    - refreshSchemasStatus
```
RefreshSchemasStatus refreshSchemasStatus
```
      The status of the refreshed schema.
- Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasStatus extends Object implements Serializable
  - Serialized Fields
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance.
    - status
```
String status
```
      The status of the schema.
    - lastRefreshDate
```
Date lastRefreshDate
```
      The date the schema was last refreshed.
    - lastFailureMessage
```
String lastFailureMessage
```
      The last failure message for the schema.
- Class com.amazonaws.services.databasemigrationservice.model.RemoveTagsFromResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      > The Amazon Resource Name (ARN) of the AWS DMS resource the tag is to be removed from.
    - tagKeys
```
List<E> tagKeys
```
      The tag key (name) of the tag to be removed.
- Class com.amazonaws.services.databasemigrationservice.model.RemoveTagsFromResourceResult extends Object implements Serializable
- Class com.amazonaws.services.databasemigrationservice.model.ReplicationInstance extends Object implements Serializable
  - Serialized Fields
    - replicationInstanceIdentifier
```
String replicationInstanceIdentifier
```
      The replication instance identifier. This parameter is stored as a lowercase string.
      
      Constraints:
      
      Must contain from 1 to 63 alphanumeric characters or hyphens.
      
      First character must be a letter.
      
      Cannot end with a hyphen or contain two consecutive hyphens.
      
      Example: myrepinstance
    - replicationInstanceClass
```
String replicationInstanceClass
```
      The compute and memory capacity of the replication instance.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - replicationInstanceStatus
```
String replicationInstanceStatus
```
      The status of the replication instance.
    - allocatedStorage
```
Integer allocatedStorage
```
      The amount of storage (in gigabytes) that is allocated for the replication instance.
    - instanceCreateTime
```
Date instanceCreateTime
```
      The time the replication instance was created.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the instance.
    - replicationSubnetGroup
```
ReplicationSubnetGroup replicationSubnetGroup
```
      The subnet group for the replication instance.
    - preferredMaintenanceWindow
```
String preferredMaintenanceWindow
```
      The maintenance window times for the replication instance.
    - pendingModifiedValues
```
ReplicationPendingModifiedValues pendingModifiedValues
```
      The pending modification values.
    - engineVersion
```
String engineVersion
```
      The engine version number of the replication instance.
    - autoMinorVersionUpgrade
```
Boolean autoMinorVersionUpgrade
```
      Boolean value indicating if minor version upgrades will be automatically applied to the instance.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier that is used to encrypt the content on the replication instance. If you do not specify a value for the KmsKeyId parameter, then AWS DMS 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.
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance.
    - replicationInstancePublicIpAddress
```
String replicationInstancePublicIpAddress
```
      The public IP address of the replication instance.
    - replicationInstancePrivateIpAddress
```
String replicationInstancePrivateIpAddress
```
      The private IP address of the replication instance.
    - publiclyAccessible
```
Boolean publiclyAccessible
```
      Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
- Class com.amazonaws.services.databasemigrationservice.model.ReplicationPendingModifiedValues extends Object implements Serializable
  - Serialized Fields
    - replicationInstanceClass
```
String replicationInstanceClass
```
      The compute and memory capacity of the replication instance.
      
      Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge
    - allocatedStorage
```
Integer allocatedStorage
```
      The amount of storage (in gigabytes) that is allocated for the replication instance.
    - engineVersion
```
String engineVersion
```
      The engine version number of the replication instance.
- Class com.amazonaws.services.databasemigrationservice.model.ReplicationSubnetGroup extends Object implements Serializable
  - Serialized Fields
    - replicationSubnetGroupIdentifier
```
String replicationSubnetGroupIdentifier
```
      The identifier of the replication instance subnet group.
    - replicationSubnetGroupDescription
```
String replicationSubnetGroupDescription
```
      The description of the replication subnet group.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - subnetGroupStatus
```
String subnetGroupStatus
```
      The status of the subnet group.
    - subnets
```
List<E> subnets
```
      The subnets that are in the subnet group.
- Class com.amazonaws.services.databasemigrationservice.model.ReplicationSubnetGroupDoesNotCoverEnoughAZsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.ReplicationTask extends Object implements Serializable
  - Serialized Fields
    - replicationTaskIdentifier
```
String replicationTaskIdentifier
```
      The replication task identifier.
      
      Constraints:
      
      Must contain from 1 to 63 alphanumeric characters or hyphens.
      
      First character must be a letter.
      
      Cannot end with a hyphen or contain two consecutive hyphens.
    - sourceEndpointArn
```
String sourceEndpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - targetEndpointArn
```
String targetEndpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Name (ARN) of the replication instance.
    - migrationType
```
String migrationType
```
      The type of migration.
    - tableMappings
```
String tableMappings
```
      Table mappings specified in the task.
    - replicationTaskSettings
```
String replicationTaskSettings
```
      The settings for the replication task.
    - status
```
String status
```
      The status of the replication task.
    - lastFailureMessage
```
String lastFailureMessage
```
      The last error (failure) message generated for the replication instance.
    - replicationTaskCreationDate
```
Date replicationTaskCreationDate
```
      The date the replication task was created.
    - replicationTaskStartDate
```
Date replicationTaskStartDate
```
      The date the replication task is scheduled to start.
    - replicationTaskArn
```
String replicationTaskArn
```
      The Amazon Resource Name (ARN) of the replication task.
    - replicationTaskStats
```
ReplicationTaskStats replicationTaskStats
```
      The statistics for the task, including elapsed time, tables loaded, and table errors.
- Class com.amazonaws.services.databasemigrationservice.model.ReplicationTaskStats extends Object implements Serializable
  - Serialized Fields
    - fullLoadProgressPercent
```
Integer fullLoadProgressPercent
```
      The percent complete for the full load migration task.
    - elapsedTimeMillis
```
Long elapsedTimeMillis
```
      The elapsed time of the task, in milliseconds.
    - tablesLoaded
```
Integer tablesLoaded
```
      The number of tables loaded for this task.
    - tablesLoading
```
Integer tablesLoading
```
      The number of tables currently loading for this task.
    - tablesQueued
```
Integer tablesQueued
```
      The number of tables queued for this task.
    - tablesErrored
```
Integer tablesErrored
```
      The number of errors that have occurred during this task.
- Class com.amazonaws.services.databasemigrationservice.model.ResourceAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.ResourceQuotaExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationTaskArn
```
String replicationTaskArn
```
      The Amazon Resource Number (ARN) of the replication task to be started.
    - startReplicationTaskType
```
String startReplicationTaskType
```
      The type of replication task.
    - cdcStartTime
```
Date cdcStartTime
```
      The start time for the Change Data Capture (CDC) operation.
- Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskResult extends Object implements Serializable
  - Serialized Fields
    - replicationTask
```
ReplicationTask replicationTask
```
      The replication task started.
- Class com.amazonaws.services.databasemigrationservice.model.StopReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationTaskArn
```
String replicationTaskArn
```
      The Amazon Resource Number(ARN) of the replication task to be stopped.
- Class com.amazonaws.services.databasemigrationservice.model.StopReplicationTaskResult extends Object implements Serializable
  - Serialized Fields
    - replicationTask
```
ReplicationTask replicationTask
```
      The replication task stopped.
- Class com.amazonaws.services.databasemigrationservice.model.StorageQuotaExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.Subnet extends Object implements Serializable
  - Serialized Fields
    - subnetIdentifier
```
String subnetIdentifier
```
      The subnet identifier.
    - subnetAvailabilityZone
```
AvailabilityZone subnetAvailabilityZone
```
      The Availability Zone of the subnet.
    - subnetStatus
```
String subnetStatus
```
      The status of the subnet.
- Class com.amazonaws.services.databasemigrationservice.model.SubnetAlreadyInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.databasemigrationservice.model.SupportedEndpointType extends Object implements Serializable
  - Serialized Fields
    - engineName
```
String engineName
```
      The database engine name.
    - supportsCDC
```
Boolean supportsCDC
```
      Indicates if Change Data Capture (CDC) is supported.
    - endpointType
```
String endpointType
```
      The type of endpoint.
- Class com.amazonaws.services.databasemigrationservice.model.TableStatistics extends Object implements Serializable
  - Serialized Fields
    - schemaName
```
String schemaName
```
      The schema name.
    - tableName
```
String tableName
```
      The name of the table.
    - inserts
```
Long inserts
```
      The number of insert actions performed on a table.
    - deletes
```
Long deletes
```
      The number of delete actions performed on a table.
    - updates
```
Long updates
```
      The number of update actions performed on a table.
    - ddls
```
Long ddls
```
      The Data Definition Language (DDL) used to build and modify the structure of your tables.
    - fullLoadRows
```
Long fullLoadRows
```
      The number of rows added during the Full Load operation.
    - lastUpdateTime
```
Date lastUpdateTime
```
      The last time the table was updated.
    - tableState
```
String tableState
```
      The state of the table.
- Class com.amazonaws.services.databasemigrationservice.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
    - value
```
String value
```
      A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and cannot be prefixed with "aws:" or "dms:". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").
- Class com.amazonaws.services.databasemigrationservice.model.TestConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - replicationInstanceArn
```
String replicationInstanceArn
```
      The Amazon Resource Number (ARN) of the replication instance.
    - endpointArn
```
String endpointArn
```
      The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
- Class com.amazonaws.services.databasemigrationservice.model.TestConnectionResult extends Object implements Serializable
  - Serialized Fields
    - connection
```
Connection connection
```
      The connection tested.
- Class com.amazonaws.services.databasemigrationservice.model.UpgradeDependencyFailureException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.datapipeline.model
- Class com.amazonaws.services.datapipeline.model.ActivatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - parameterValues
```
com.amazonaws.internal.SdkInternalList<T> parameterValues
```
      A list of parameter values to pass to the pipeline at activation.
    - startTimestamp
```
Date startTimestamp
```
      The date and time to resume the pipeline. By default, the pipeline resumes from the last completed execution.
- Class com.amazonaws.services.datapipeline.model.ActivatePipelineResult extends Object implements Serializable
- Class com.amazonaws.services.datapipeline.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      The tags to add, as key/value pairs.
- Class com.amazonaws.services.datapipeline.model.AddTagsResult extends Object implements Serializable
- Class com.amazonaws.services.datapipeline.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
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.
    - uniqueId
```
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.
    - description
```
String description
```
      The description for the pipeline.
    - tags
```
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.
- Class com.amazonaws.services.datapipeline.model.CreatePipelineResult extends Object implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID that AWS Data Pipeline assigns the newly created pipeline. For example, df-06372391ZG65EXAMPLE.
- Class com.amazonaws.services.datapipeline.model.DeactivatePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - cancelActive
```
Boolean cancelActive
```
      Indicates whether to cancel any running objects. The default is true, which sets the state of any running objects to CANCELED. If this value is false, the pipeline is deactivated after all running objects finish.
- Class com.amazonaws.services.datapipeline.model.DeactivatePipelineResult extends Object implements Serializable
- Class com.amazonaws.services.datapipeline.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
- Class com.amazonaws.services.datapipeline.model.DescribeObjectsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline that contains the object definitions.
    - objectIds
```
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.
    - evaluateExpressions
```
Boolean evaluateExpressions
```
      Indicates whether any expressions in the object should be evaluated when the object descriptions are returned.
    - marker
```
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.
- Class com.amazonaws.services.datapipeline.model.DescribeObjectsResult extends Object implements Serializable
  - Serialized Fields
    - pipelineObjects
```
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
```
      An array of object definitions.
    - marker
```
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.
    - hasMoreResults
```
Boolean hasMoreResults
```
      Indicates whether there are more results to return.
- Class com.amazonaws.services.datapipeline.model.DescribePipelinesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineIds
```
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.
- Class com.amazonaws.services.datapipeline.model.DescribePipelinesResult extends Object implements Serializable
  - Serialized Fields
    - pipelineDescriptionList
```
com.amazonaws.internal.SdkInternalList<T> pipelineDescriptionList
```
      An array of descriptions for the specified pipelines.
- Class com.amazonaws.services.datapipeline.model.EvaluateExpressionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - objectId
```
String objectId
```
      The ID of the object.
    - expression
```
String expression
```
      The expression to evaluate.
- Class com.amazonaws.services.datapipeline.model.EvaluateExpressionResult extends Object implements Serializable
  - Serialized Fields
    - evaluatedExpression
```
String evaluatedExpression
```
      The evaluated expression.
- Class com.amazonaws.services.datapipeline.model.Field extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The field identifier.
    - stringValue
```
String stringValue
```
      The field value, expressed as a String.
    - refValue
```
String refValue
```
      The field value, expressed as the identifier of another object.
- Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - version
```
String version
```
      The version of the pipeline definition to retrieve. Set this parameter to latest (default) to use the last definition saved to the pipeline or active to use the last definition that was activated.
- Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionResult extends Object implements Serializable
  - Serialized Fields
    - pipelineObjects
```
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
```
      The objects defined in the pipeline.
    - parameterObjects
```
com.amazonaws.internal.SdkInternalList<T> parameterObjects
```
      The parameter objects used in the pipeline definition.
    - parameterValues
```
com.amazonaws.internal.SdkInternalList<T> parameterValues
```
      The parameter values used in the pipeline definition.
- Class com.amazonaws.services.datapipeline.model.InstanceIdentity extends Object implements Serializable
  - Serialized Fields
    - document
```
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.
    - signature
```
String signature
```
      A signature which can be used to verify the accuracy and authenticity of the information provided in the instance identity document.
- Class com.amazonaws.services.datapipeline.model.InternalServiceErrorException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.datapipeline.model.InvalidRequestException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.datapipeline.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - marker
```
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.
- Class com.amazonaws.services.datapipeline.model.ListPipelinesResult extends Object implements Serializable
  - Serialized Fields
    - pipelineIdList
```
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.
    - marker
```
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.
    - hasMoreResults
```
Boolean hasMoreResults
```
      Indicates whether there are more results that can be obtained by a subsequent call.
- Class com.amazonaws.services.datapipeline.model.Operator extends Object implements Serializable
  - Serialized Fields
    - type
```
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:
      
      name
      
      @sphere
      
      parent
      
      @componentParent
      
      @instanceParent
      
      @status
      
      @scheduledStartTime
      
      @scheduledEndTime
      
      @actualStartTime
      
      @actualEndTime
      
      The comparison operators GE, LE, and BETWEEN act on the following fields:
      
      @scheduledStartTime
      
      @scheduledEndTime
      
      @actualStartTime
      
      @actualEndTime
      
      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".
    - values
```
com.amazonaws.internal.SdkInternalList<T> values
```
      The value that the actual field value will be compared with.
- Class com.amazonaws.services.datapipeline.model.ParameterAttribute extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The field identifier.
    - stringValue
```
String stringValue
```
      The field value, expressed as a String.
- Class com.amazonaws.services.datapipeline.model.ParameterObject extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the parameter object.
    - attributes
```
com.amazonaws.internal.SdkInternalList<T> attributes
```
      The attributes of the parameter object.
- Class com.amazonaws.services.datapipeline.model.ParameterValue extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the parameter value.
    - stringValue
```
String stringValue
```
      The field value, expressed as a String.
- Class com.amazonaws.services.datapipeline.model.PipelineDeletedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.datapipeline.model.PipelineDescription extends Object implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
    - name
```
String name
```
      The name of the pipeline.
    - fields
```
com.amazonaws.internal.SdkInternalList<T> fields
```
      A list of read-only fields that contain metadata about the pipeline:
    - description
```
String description
```
      Description of the pipeline.
    - tags
```
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.
- Class com.amazonaws.services.datapipeline.model.PipelineIdName extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.
    - name
```
String name
```
      The name of the pipeline.
- Class com.amazonaws.services.datapipeline.model.PipelineNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.datapipeline.model.PipelineObject extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the object.
    - name
```
String name
```
      The name of the object.
    - fields
```
com.amazonaws.internal.SdkInternalList<T> fields
```
      Key-value pairs that define the properties of the object.
- Class com.amazonaws.services.datapipeline.model.PollForTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - workerGroup
```
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.
    - hostname
```
String hostname
```
      The public DNS name of the calling task runner.
    - instanceIdentity
```
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.
- Class com.amazonaws.services.datapipeline.model.PollForTaskResult extends Object implements Serializable
  - Serialized Fields
    - taskObject
```
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.
- Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - pipelineObjects
```
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
```
      The objects that define the pipeline. These objects overwrite the existing pipeline definition.
    - parameterObjects
```
com.amazonaws.internal.SdkInternalList<T> parameterObjects
```
      The parameter objects used with the pipeline.
    - parameterValues
```
com.amazonaws.internal.SdkInternalList<T> parameterValues
```
      The parameter values used with the pipeline.
- Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionResult extends Object implements Serializable
  - Serialized Fields
    - validationErrors
```
com.amazonaws.internal.SdkInternalList<T> validationErrors
```
      The validation errors that are associated with the objects defined in pipelineObjects.
    - validationWarnings
```
com.amazonaws.internal.SdkInternalList<T> validationWarnings
```
      The validation warnings that are associated with the objects defined in pipelineObjects.
    - errored
```
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.
- Class com.amazonaws.services.datapipeline.model.Query extends Object implements Serializable
  - Serialized Fields
    - selectors
```
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.
- Class com.amazonaws.services.datapipeline.model.QueryObjectsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - query
```
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.
    - sphere
```
String sphere
```
      Indicates whether the query applies to components or instances. The possible values are: COMPONENT, INSTANCE, and ATTEMPT.
    - marker
```
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.
    - limit
```
Integer limit
```
      The maximum number of object names that QueryObjects will return in a single call. The default value is 100.
- Class com.amazonaws.services.datapipeline.model.QueryObjectsResult extends Object implements Serializable
  - Serialized Fields
    - ids
```
com.amazonaws.internal.SdkInternalList<T> ids
```
      The identifiers that match the query selectors.
    - marker
```
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.
    - hasMoreResults
```
Boolean hasMoreResults
```
      Indicates whether there are more results that can be obtained by a subsequent call.
- Class com.amazonaws.services.datapipeline.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - tagKeys
```
com.amazonaws.internal.SdkInternalList<T> tagKeys
```
      The keys of the tags to remove.
- Class com.amazonaws.services.datapipeline.model.RemoveTagsResult extends Object implements Serializable
- Class com.amazonaws.services.datapipeline.model.ReportTaskProgressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskId
```
String taskId
```
      The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
    - fields
```
com.amazonaws.internal.SdkInternalList<T> fields
```
      Key-value pairs that define the properties of the ReportTaskProgressInput object.
- Class com.amazonaws.services.datapipeline.model.ReportTaskProgressResult extends Object implements Serializable
  - Serialized Fields
    - canceled
```
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.
- Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskrunnerId
```
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.
    - workerGroup
```
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.
    - hostname
```
String hostname
```
      The public DNS name of the task runner.
- Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatResult extends Object implements Serializable
  - Serialized Fields
    - terminate
```
Boolean terminate
```
      Indicates whether the calling task runner should terminate.
- Class com.amazonaws.services.datapipeline.model.Selector extends Object implements Serializable
  - Serialized Fields
    - fieldName
```
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 operator
```
- Class com.amazonaws.services.datapipeline.model.SetStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline that contains the objects.
    - objectIds
```
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.
    - status
```
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.
- Class com.amazonaws.services.datapipeline.model.SetTaskStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - taskId
```
String taskId
```
      The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.
    - taskStatus
```
String taskStatus
```
      If FINISHED, the task successfully completed. If FAILED, the task ended unsuccessfully. Preconditions use false.
    - errorId
```
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.
    - errorMessage
```
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.
    - errorStackTrace
```
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.
- Class com.amazonaws.services.datapipeline.model.SetTaskStatusResult extends Object implements Serializable
- Class com.amazonaws.services.datapipeline.model.Tag extends Object implements Serializable
  - Serialized Fields
    - key
```
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.
    - value
```
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.
- Class com.amazonaws.services.datapipeline.model.TaskNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.datapipeline.model.TaskObject extends Object implements Serializable
  - Serialized Fields
    - taskId
```
String taskId
```
      An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline that provided the task.
    - attemptId
```
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.
    - objects
```
Map<K,V> objects
```
      Connection information for the location where the task runner will publish the output of the task.
- Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - pipelineId
```
String pipelineId
```
      The ID of the pipeline.
    - pipelineObjects
```
com.amazonaws.internal.SdkInternalList<T> pipelineObjects
```
      The objects that define the pipeline changes to validate against the pipeline.
    - parameterObjects
```
com.amazonaws.internal.SdkInternalList<T> parameterObjects
```
      The parameter objects used with the pipeline.
    - parameterValues
```
com.amazonaws.internal.SdkInternalList<T> parameterValues
```
      The parameter values used with the pipeline.
- Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionResult extends Object implements Serializable
  - Serialized Fields
    - validationErrors
```
com.amazonaws.internal.SdkInternalList<T> validationErrors
```
      Any validation errors that were found.
    - validationWarnings
```
com.amazonaws.internal.SdkInternalList<T> validationWarnings
```
      Any validation warnings that were found.
    - errored
```
Boolean errored
```
      Indicates whether there were validation errors.
- Class com.amazonaws.services.datapipeline.model.ValidationError extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the object that contains the validation error.
    - errors
```
com.amazonaws.internal.SdkInternalList<T> errors
```
      A description of the validation error.
- Class com.amazonaws.services.datapipeline.model.ValidationWarning extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The identifier of the object that contains the validation warning.
    - warnings
```
com.amazonaws.internal.SdkInternalList<T> warnings
```
      A description of the validation warning.
Package com.amazonaws.services.devicefarm.model
- Class com.amazonaws.services.devicefarm.model.AccountSettings extends Object implements Serializable
  - Serialized Fields
    - awsAccountNumber
```
String awsAccountNumber
```
      The AWS account number specified in the AccountSettings container.
    - unmeteredDevices
```
Map<K,V> unmeteredDevices
```
      Returns the unmetered devices you have purchased or want to purchase.
    - unmeteredRemoteAccessDevices
```
Map<K,V> unmeteredRemoteAccessDevices
```
      Returns the unmetered remote access devices you have purchased or want to purchase.
- Class com.amazonaws.services.devicefarm.model.ArgumentException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.devicefarm.model.Artifact extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The artifact's ARN.
    - name
```
String name
```
      The artifact's name.
    - type
```
String type
```
      The artifact's type.
      
      Allowed values include the following:
      
      UNKNOWN: An unknown type.
      
      SCREENSHOT: The screenshot type.
      
      DEVICE_LOG: The device log type.
      
      MESSAGE_LOG: The message log type.
      
      RESULT_LOG: The result log type.
      
      SERVICE_LOG: The service log type.
      
      WEBKIT_LOG: The web kit log type.
      
      INSTRUMENTATION_OUTPUT: The instrumentation type.
      
      EXERCISER_MONKEY_OUTPUT: For Android, the artifact (log) generated by an Android fuzz test.
      
      CALABASH_JSON_OUTPUT: The Calabash JSON output type.
      
      CALABASH_PRETTY_OUTPUT: The Calabash pretty output type.
      
      CALABASH_STANDARD_OUTPUT: The Calabash standard output type.
      
      CALABASH_JAVA_XML_OUTPUT: The Calabash Java XML output type.
      
      AUTOMATION_OUTPUT: The automation output type.
      
      APPIUM_SERVER_OUTPUT: The Appium server output type.
      
      APPIUM_JAVA_OUTPUT: The Appium Java output type.
      
      APPIUM_JAVA_XML_OUTPUT: The Appium Java XML output type.
      
      APPIUM_PYTHON_OUTPUT: The Appium Python output type.
      
      APPIUM_PYTHON_XML_OUTPUT: The Appium Python XML output type.
      
      EXPLORER_EVENT_LOG: The Explorer event log output type.
      
      EXPLORER_SUMMARY_LOG: The Explorer summary log output type.
      
      APPLICATION_CRASH_REPORT: The application crash report output type.
      
      XCTEST_LOG: The XCode test output type.
    - extension
```
String extension
```
      The artifact's file extension.
    - url
```
String url
```
      The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the artifact's file.
- Class com.amazonaws.services.devicefarm.model.Counters extends Object implements Serializable
  - Serialized Fields
    - total
```
Integer total
```
      The total number of entities.
    - passed
```
Integer passed
```
      The number of passed entities.
    - failed
```
Integer failed
```
      The number of failed entities.
    - warned
```
Integer warned
```
      The number of warned entities.
    - errored
```
Integer errored
```
      The number of errored entities.
    - stopped
```
Integer stopped
```
      The number of stopped entities.
    - skipped
```
Integer skipped
```
      The number of skipped entities.
- Class com.amazonaws.services.devicefarm.model.CPU extends Object implements Serializable
  - Serialized Fields
    - frequency
```
String frequency
```
      The CPU's frequency.
    - architecture
```
String architecture
```
      The CPU's architecture, for example x86 or ARM.
    - clock
```
Double clock
```
      The clock speed of the device's CPU, expressed in hertz (Hz). For example, a 1.2 GHz CPU is expressed as 1200000000.
- Class com.amazonaws.services.devicefarm.model.CreateDevicePoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - projectArn
```
String projectArn
```
      The ARN of the project for the device pool.
    - name
```
String name
```
      The device pool's name.
    - description
```
String description
```
      The device pool's description.
    - rules
```
List<E> rules
```
      The device pool's rules.
- Class com.amazonaws.services.devicefarm.model.CreateDevicePoolResult extends Object implements Serializable
  - Serialized Fields
    - devicePool
```
DevicePool devicePool
```
      The newly created device pool.
- Class com.amazonaws.services.devicefarm.model.CreateProjectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The project's name.
- Class com.amazonaws.services.devicefarm.model.CreateProjectResult extends Object implements Serializable
  - Serialized Fields
    - project
```
Project project
```
      The newly created project.
- Class com.amazonaws.services.devicefarm.model.CreateUploadRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - projectArn
```
String projectArn
```
      The ARN of the project for the upload.
    - name
```
String name
```
      The upload's file name.
    - type
```
String type
```
      The upload's upload type.
      
      Must be one of the following values:
      
      ANDROID_APP: An Android upload.
      
      IOS_APP: An iOS upload.
      
      WEB_APP: A web appliction 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.
      
      APPIUM_PYTHON_TEST_PACKAGE: An Appium Python 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.
      
      APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
      
      CALABASH_TEST_PACKAGE: A Calabash test package upload.
      
      INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
      
      UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
      
      UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
      
      XCTEST_TEST_PACKAGE: An XCode test package upload.
      
      XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
      
      Note If you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.
    - contentType
```
String contentType
```
      The upload's content type (for example, "application/octet-stream").
- Class com.amazonaws.services.devicefarm.model.CreateUploadResult extends Object implements Serializable
  - Serialized Fields
    - upload
```
Upload upload
```
      The newly created upload.
- Class com.amazonaws.services.devicefarm.model.DeleteDevicePoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.
- Class com.amazonaws.services.devicefarm.model.DeleteDevicePoolResult extends Object implements Serializable
- Class com.amazonaws.services.devicefarm.model.DeleteProjectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.
- Class com.amazonaws.services.devicefarm.model.DeleteProjectResult extends Object implements Serializable
- Class com.amazonaws.services.devicefarm.model.DeleteRunRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) for the run you wish to delete.
- Class com.amazonaws.services.devicefarm.model.DeleteRunResult extends Object implements Serializable
- Class com.amazonaws.services.devicefarm.model.DeleteUploadRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.
- Class com.amazonaws.services.devicefarm.model.DeleteUploadResult extends Object implements Serializable
- Class com.amazonaws.services.devicefarm.model.Device extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The device's ARN.
    - name
```
String name
```
      The device's display name.
    - manufacturer
```
String manufacturer
```
      The device's manufacturer name.
    - model
```
String model
```
      The device's model name.
    - formFactor
```
String formFactor
```
      The device's form factor.
      
      Allowed values include:
      
      PHONE: The phone form factor.
      
      TABLET: The tablet form factor.
    - platform
```
String platform
```
      The device's platform.
      
      Allowed values include:
      
      ANDROID: The Android platform.
      
      IOS: The iOS platform.
    - os
```
String os
```
      The device's operating system type.
    - cpu
```
CPU cpu
```
      Information about the device's CPU.
    - resolution
```
Resolution resolution
```
    - heapSize
```
Long heapSize
```
      The device's heap size, expressed in bytes.
    - memory
```
Long memory
```
      The device's total memory size, expressed in bytes.
    - image
```
String image
```
      The device's image name.
    - carrier
```
String carrier
```
      The device's carrier.
    - radio
```
String radio
```
      The device's radio.
- Class com.amazonaws.services.devicefarm.model.DeviceMinutes extends Object implements Serializable
  - Serialized Fields
    - total
```
Double total
```
      When specified, represents the total minutes used by the resource to run tests.
    - metered
```
Double metered
```
      When specified, represents only the sum of metered minutes used by the resource to run tests.
    - unmetered
```
Double unmetered
```
      When specified, represents only the sum of unmetered minutes used by the resource to run tests.
- Class com.amazonaws.services.devicefarm.model.DevicePool extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The device pool's ARN.
    - name
```
String name
```
      The device pool's name.
    - description
```
String description
```
      The device pool's description.
    - type
```
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.
    - rules
```
List<E> rules
```
      Information about the device pool's rules.
- Class com.amazonaws.services.devicefarm.model.DevicePoolCompatibilityResult extends Object implements Serializable
  - Serialized Fields
    - device
```
Device device
```
    - compatible
```
Boolean compatible
```
      Whether the result was compatible with the device pool.
    - incompatibilityMessages
```
List<E> incompatibilityMessages
```
      Information about the compatibility.
- Class com.amazonaws.services.devicefarm.model.GetAccountSettingsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.devicefarm.model.GetAccountSettingsResult extends Object implements Serializable
  - Serialized Fields
    - accountSettings
```
AccountSettings accountSettings
```
- Class com.amazonaws.services.devicefarm.model.GetDevicePoolCompatibilityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - devicePoolArn
```
String devicePoolArn
```
      The device pool's ARN.
    - appArn
```
String appArn
```
      The ARN of the app that is associated with the specified device pool.
    - testType
```
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.
      
      APPIUM_PYTHON: The Appium Python type.
      
      APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
      
      APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
      
      APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
      
      CALABASH: The Calabash type.
      
      INSTRUMENTATION: The Instrumentation type.
      
      UIAUTOMATION: The uiautomation type.
      
      UIAUTOMATOR: The uiautomator type.
      
      XCTEST: The XCode test type.
      
      XCTEST_UI: The XCode UI test type.
- Class com.amazonaws.services.devicefarm.model.GetDevicePoolCompatibilityResult extends Object implements Serializable
  - Serialized Fields
    - compatibleDevices
```
List<E> compatibleDevices
```
      Information about compatible devices.
    - incompatibleDevices
```
List<E> incompatibleDevices
```
      Information about incompatible devices.
- Class com.amazonaws.services.devicefarm.model.GetDevicePoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The device pool's ARN.
- Class com.amazonaws.services.devicefarm.model.GetDevicePoolResult extends Object implements Serializable
  - Serialized Fields
    - devicePool
```
DevicePool devicePool
```
- Class com.amazonaws.services.devicefarm.model.GetDeviceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The device type's ARN.
- Class com.amazonaws.services.devicefarm.model.GetDeviceResult extends Object implements Serializable
  - Serialized Fields
    - device
```
Device device
```
- Class com.amazonaws.services.devicefarm.model.GetJobRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The job's ARN.
- Class com.amazonaws.services.devicefarm.model.GetJobResult extends Object implements Serializable
  - Serialized Fields
    - job
```
Job job
```
- Class com.amazonaws.services.devicefarm.model.GetOfferingStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.GetOfferingStatusResult extends Object implements Serializable
  - Serialized Fields
    - current
```
Map<K,V> current
```
      When specified, gets the offering status for the current period.
    - nextPeriod
```
Map<K,V> nextPeriod
```
      When specified, gets the offering status for the next period.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.GetProjectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The project's ARN.
- Class com.amazonaws.services.devicefarm.model.GetProjectResult extends Object implements Serializable
  - Serialized Fields
    - project
```
Project project
```
- Class com.amazonaws.services.devicefarm.model.GetRunRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The run's ARN.
- Class com.amazonaws.services.devicefarm.model.GetRunResult extends Object implements Serializable
  - Serialized Fields
    - run
```
Run run
```
- Class com.amazonaws.services.devicefarm.model.GetSuiteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The suite's ARN.
- Class com.amazonaws.services.devicefarm.model.GetSuiteResult extends Object implements Serializable
  - Serialized Fields
    - suite
```
Suite suite
```
- Class com.amazonaws.services.devicefarm.model.GetTestRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The test's ARN.
- Class com.amazonaws.services.devicefarm.model.GetTestResult extends Object implements Serializable
  - Serialized Fields
    - test
```
Test test
```
- Class com.amazonaws.services.devicefarm.model.GetUploadRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The upload's ARN.
- Class com.amazonaws.services.devicefarm.model.GetUploadResult extends Object implements Serializable
  - Serialized Fields
    - upload
```
Upload upload
```
- Class com.amazonaws.services.devicefarm.model.IdempotencyException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.devicefarm.model.IncompatibilityMessage extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A message about the incompatibility.
    - type
```
String type
```
      The type of incompatibility.
      
      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).
- Class com.amazonaws.services.devicefarm.model.Job extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The job's ARN.
    - name
```
String name
```
      The job's name.
    - type
```
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.
      
      APPIUM_PYTHON: The Appium Python type.
      
      APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
      
      APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
      
      APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
      
      CALABASH: The Calabash type.
      
      INSTRUMENTATION: The Instrumentation type.
      
      UIAUTOMATION: The uiautomation type.
      
      UIAUTOMATOR: The uiautomator type.
      
      XCTEST: The XCode test type.
      
      XCTEST_UI: The XCode UI test type.
    - created
```
Date created
```
      When the job was created.
    - status
```
String status
```
      The job's status.
      
      Allowed values include:
      
      PENDING: A pending status.
      
      PENDING_CONCURRENCY: A pending concurrency status.
      
      PENDING_DEVICE: A pending device status.
      
      PROCESSING: A processing status.
      
      SCHEDULING: A scheduling status.
      
      PREPARING: A preparing status.
      
      RUNNING: A running status.
      
      COMPLETED: A completed status.
      
      STOPPING: A stopping status.
    - result
```
String result
```
      The job's result.
      
      Allowed values include:
      
      PENDING: A pending condition.
      
      PASSED: A passing condition.
      
      WARNED: A warning condition.
      
      FAILED: A failed condition.
      
      SKIPPED: A skipped condition.
      
      ERRORED: An error condition.
      
      STOPPED: A stopped condition.
    - started
```
Date started
```
      The job's start time.
    - stopped
```
Date stopped
```
      The job's stop time.
    - counters
```
Counters counters
```
      The job's result counters.
    - message
```
String message
```
      A message about the job's result.
    - device
```
Device device
```
    - deviceMinutes
```
DeviceMinutes deviceMinutes
```
      Represents the total (metered or unmetered) minutes used by the job.
- Class com.amazonaws.services.devicefarm.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.devicefarm.model.ListArtifactsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Run, Job, Suite, or Test ARN.
    - type
```
String type
```
      The artifacts' type.
      
      Allowed values include:
      
      FILE: The artifacts are files.
      
      LOG: The artifacts are logs.
      
      SCREENSHOT: The artifacts are screenshots.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListArtifactsResult extends Object implements Serializable
  - Serialized Fields
    - artifacts
```
List<E> artifacts
```
      Information about the artifacts.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListDevicePoolsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The project ARN.
    - type
```
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.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListDevicePoolsResult extends Object implements Serializable
  - Serialized Fields
    - devicePools
```
List<E> devicePools
```
      Information about the device pools.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListDevicesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The device types' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListDevicesResult extends Object implements Serializable
  - Serialized Fields
    - devices
```
List<E> devices
```
      Information about the devices.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The jobs' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListJobsResult extends Object implements Serializable
  - Serialized Fields
    - jobs
```
List<E> jobs
```
      Information about the jobs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListOfferingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListOfferingsResult extends Object implements Serializable
  - Serialized Fields
    - offerings
```
List<E> offerings
```
      A value representing the list offering results.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListOfferingTransactionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListOfferingTransactionsResult extends Object implements Serializable
  - Serialized Fields
    - offeringTransactions
```
List<E> offeringTransactions
```
      The audit log of subscriptions you have purchased and modified through AWS Device Farm.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListProjectsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The projects' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListProjectsResult extends Object implements Serializable
  - Serialized Fields
    - projects
```
List<E> projects
```
      Information about the projects.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListRunsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The runs' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListRunsResult extends Object implements Serializable
  - Serialized Fields
    - runs
```
List<E> runs
```
      Information about the runs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListSamplesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The samples' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListSamplesResult extends Object implements Serializable
  - Serialized Fields
    - samples
```
List<E> samples
```
      Information about the samples.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListSuitesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The suites' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListSuitesResult extends Object implements Serializable
  - Serialized Fields
    - suites
```
List<E> suites
```
      Information about the suites.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListTestsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The tests' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListTestsResult extends Object implements Serializable
  - Serialized Fields
    - tests
```
List<E> tests
```
      Information about the tests.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListUniqueProblemsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The unique problems' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListUniqueProblemsResult extends Object implements Serializable
  - Serialized Fields
    - uniqueProblems
```
Map<K,V> uniqueProblems
```
      Information about the unique problems.
      
      Allowed values include:
      
      PENDING: A pending condition.
      
      PASSED: A passing condition.
      
      WARNED: A warning condition.
      
      FAILED: A failed condition.
      
      SKIPPED: A skipped condition.
      
      ERRORED: An error condition.
      
      STOPPED: A stopped condition.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListUploadsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The uploads' ARNs.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.ListUploadsResult extends Object implements Serializable
  - Serialized Fields
    - uploads
```
List<E> uploads
```
      Information about the uploads.
    - nextToken
```
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.
- Class com.amazonaws.services.devicefarm.model.Location extends Object implements Serializable
  - Serialized Fields
    - latitude
```
Double latitude
```
      The latitude.
    - longitude
```
Double longitude
```
      The longitude.
- Class com.amazonaws.services.devicefarm.model.MonetaryAmount extends Object implements Serializable
  - Serialized Fields
    - amount
```
Double amount
```
      The numerical amount of an offering or transaction.
    - currencyCode
```
String currencyCode
```
      The currency code of a monetary amount. For example, USD means "U.S. dollars."
- Class com.amazonaws.services.devicefarm.model.NotEligibleException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.devicefarm.model.NotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.devicefarm.model.Offering extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID that corresponds to a device offering.
    - description
```
String description
```
      A string describing the offering.
    - type
```
String type
```
      The type of offering (e.g., "RECURRING") for a device.
    - platform
```
String platform
```
      The platform of the device (e.g., ANDROID or IOS).
    - recurringCharges
```
List<E> recurringCharges
```
      Specifies whether there are recurring charges for the offering.
- Class com.amazonaws.services.devicefarm.model.OfferingStatus extends Object implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type specified for the offering status.
    - offering
```
Offering offering
```
      Represents the metadata of an offering status.
    - quantity
```
Integer quantity
```
      The number of available devices in the offering.
    - effectiveOn
```
Date effectiveOn
```
      The date on which the offering is effective.
- Class com.amazonaws.services.devicefarm.model.OfferingTransaction extends Object implements Serializable
  - Serialized Fields
    - offeringStatus
```
OfferingStatus offeringStatus
```
      The status of an offering transaction.
    - transactionId
```
String transactionId
```
      The transaction ID of the offering transaction.
    - createdOn
```
Date createdOn
```
      The date on which an offering transaction was created.
    - cost
```
MonetaryAmount cost
```
      The cost of an offering transaction.
- Class com.amazonaws.services.devicefarm.model.Problem extends Object implements Serializable
  - Serialized Fields
    - run
```
ProblemDetail run
```
      Information about the associated run.
    - job
```
ProblemDetail job
```
      Information about the associated job.
    - suite
```
ProblemDetail suite
```
      Information about the associated suite.
    - test
```
ProblemDetail test
```
      Information about the associated test.
    - device
```
Device device
```
      Information about the associated device.
    - result
```
String result
```
      The problem's result.
      
      Allowed values include:
      
      PENDING: A pending condition.
      
      PASSED: A passing condition.
      
      WARNED: A warning condition.
      
      FAILED: A failed condition.
      
      SKIPPED: A skipped condition.
      
      ERRORED: An error condition.
      
      STOPPED: A stopped condition.
    - message
```
String message
```
      A message about the problem's result.
- Class com.amazonaws.services.devicefarm.model.ProblemDetail extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The problem detail's ARN.
    - name
```
String name
```
      The problem detail's name.
- Class com.amazonaws.services.devicefarm.model.Project extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The project's ARN.
    - name
```
String name
```
      The project's name.
    - created
```
Date created
```
      When the project was created.
- Class com.amazonaws.services.devicefarm.model.PurchaseOfferingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - offeringId
```
String offeringId
```
      The ID of the offering.
    - quantity
```
Integer quantity
```
      The number of device slots you wish to purchase in an offering request.
- Class com.amazonaws.services.devicefarm.model.PurchaseOfferingResult extends Object implements Serializable
  - Serialized Fields
    - offeringTransaction
```
OfferingTransaction offeringTransaction
```
      Represents the offering transaction for the purchase result.
- Class com.amazonaws.services.devicefarm.model.Radios extends Object implements Serializable
  - Serialized Fields
    - wifi
```
Boolean wifi
```
      True if Wi-Fi is enabled at the beginning of the test; otherwise, false.
    - bluetooth
```
Boolean bluetooth
```
      True if Bluetooth is enabled at the beginning of the test; otherwise, false.
    - nfc
```
Boolean nfc
```
      True if NFC is enabled at the beginning of the test; otherwise, false.
    - gps
```
Boolean gps
```
      True if GPS is enabled at the beginning of the test; otherwise, false.
- Class com.amazonaws.services.devicefarm.model.RecurringCharge extends Object implements Serializable
  - Serialized Fields
    - cost
```
MonetaryAmount cost
```
      The cost of the recurring charge.
    - frequency
```
String frequency
```
      The frequency in which charges will recur.
- Class com.amazonaws.services.devicefarm.model.RenewOfferingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - offeringId
```
String offeringId
```
      The ID of a request to renew an offering.
    - quantity
```
Integer quantity
```
      The quantity requested in an offering renewal.
- Class com.amazonaws.services.devicefarm.model.RenewOfferingResult extends Object implements Serializable
  - Serialized Fields
    - offeringTransaction
```
OfferingTransaction offeringTransaction
```
      Represents the status of the offering transaction for the renewal.
- Class com.amazonaws.services.devicefarm.model.Resolution extends Object implements Serializable
  - Serialized Fields
    - width
```
Integer width
```
      The screen resolution's width, expressed in pixels.
    - height
```
Integer height
```
      The screen resolution's height, expressed in pixels.
- Class com.amazonaws.services.devicefarm.model.Rule extends Object implements Serializable
  - Serialized Fields
    - attribute
```
String attribute
```
      The rule's stringified attribute. For example, specify the value as "\"abc\"".
      
      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).
    - operator
```
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.
    - value
```
String value
```
      The rule's value.
- Class com.amazonaws.services.devicefarm.model.Run extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The run's ARN.
    - name
```
String name
```
      The run's name.
    - type
```
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.
      
      APPIUM_PYTHON: The Appium Python type.
      
      APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
      
      APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
      
      APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
      
      CALABASH: The Calabash type.
      
      INSTRUMENTATION: The Instrumentation type.
      
      UIAUTOMATION: The uiautomation type.
      
      UIAUTOMATOR: The uiautomator type.
      
      XCTEST: The XCode test type.
      
      XCTEST_UI: The XCode UI test type.
    - platform
```
String platform
```
      The run's platform.
      
      Allowed values include:
      
      ANDROID: The Android platform.
      
      IOS: The iOS platform.
    - created
```
Date created
```
      When the run was created.
    - status
```
String status
```
      The run's status.
      
      Allowed values include:
      
      PENDING: A pending status.
      
      PENDING_CONCURRENCY: A pending concurrency status.
      
      PENDING_DEVICE: A pending device status.
      
      PROCESSING: A processing status.
      
      SCHEDULING: A scheduling status.
      
      PREPARING: A preparing status.
      
      RUNNING: A running status.
      
      COMPLETED: A completed status.
      
      STOPPING: A stopping status.
    - result
```
String result
```
      The run's result.
      
      Allowed values include:
      
      PENDING: A pending condition.
      
      PASSED: A passing condition.
      
      WARNED: A warning condition.
      
      FAILED: A failed condition.
      
      SKIPPED: A skipped condition.
      
      ERRORED: An error condition.
      
      STOPPED: A stopped condition.
    - started
```
Date started
```
      The run's start time.
    - stopped
```
Date stopped
```
      The run's stop time.
    - counters
```
Counters counters
```
      The run's result counters.
    - message
```
String message
```
      A message about the run's result.
    - totalJobs
```
Integer totalJobs
```
      The total number of jobs for the run.
    - completedJobs
```
Integer completedJobs
```
      The total number of completed jobs.
    - billingMethod
```
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 deviceMinutes
```
      Represents the total (metered or unmetered) minutes used by the test run.
- Class com.amazonaws.services.devicefarm.model.Sample extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The sample's ARN.
    - type
```
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.
    - url
```
String url
```
      The pre-signed Amazon S3 URL that can be used with a corresponding GET request to download the sample's file.
- Class com.amazonaws.services.devicefarm.model.ScheduleRunConfiguration extends Object implements Serializable
  - Serialized Fields
    - extraDataPackageArn
```
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.
    - networkProfileArn
```
String networkProfileArn
```
      Reserved for internal use.
    - locale
```
String locale
```
      Information about the locale that is used for the run.
    - location
```
Location location
```
      Information about the location that is used for the run.
    - radios
```
Radios radios
```
      Information about the radio states for the run.
    - auxiliaryApps
```
List<E> auxiliaryApps
```
      A list of auxiliary apps for the run.
    - billingMethod
```
String billingMethod
```
      Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is unmetered.
- Class com.amazonaws.services.devicefarm.model.ScheduleRunRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - projectArn
```
String projectArn
```
      The ARN of the project for the run to be scheduled.
    - appArn
```
String appArn
```
      The ARN of the app to schedule a run.
    - devicePoolArn
```
String devicePoolArn
```
      The ARN of the device pool for the run to be scheduled.
    - name
```
String name
```
      The name for the run to be scheduled.
    - test
```
ScheduleRunTest test
```
      Information about the test for the run to be scheduled.
    - configuration
```
ScheduleRunConfiguration configuration
```
      Information about the settings for the run to be scheduled.
- Class com.amazonaws.services.devicefarm.model.ScheduleRunResult extends Object implements Serializable
  - Serialized Fields
    - run
```
Run run
```
      Information about the scheduled run.
- Class com.amazonaws.services.devicefarm.model.ScheduleRunTest extends Object implements Serializable
  - Serialized Fields
    - type
```
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.
      
      APPIUM_PYTHON: The Appium Python type.
      
      APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
      
      APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
      
      APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
      
      CALABASH: The Calabash type.
      
      INSTRUMENTATION: The Instrumentation type.
      
      UIAUTOMATION: The uiautomation type.
      
      UIAUTOMATOR: The uiautomator type.
      
      XCTEST: The XCode test type.
      
      XCTEST_UI: The XCode UI test type.
    - testPackageArn
```
String testPackageArn
```
      The ARN of the uploaded test that will be run.
    - filter
```
String filter
```
      The test's filter.
    - parameters
```
Map<K,V> parameters
```
      The test's parameters, such as test framework parameters and fixture settings.
- Class com.amazonaws.services.devicefarm.model.ServiceAccountException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.devicefarm.model.StopRunRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.
- Class com.amazonaws.services.devicefarm.model.StopRunResult extends Object implements Serializable
  - Serialized Fields
    - run
```
Run run
```
- Class com.amazonaws.services.devicefarm.model.Suite extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The suite's ARN.
    - name
```
String name
```
      The suite's name.
    - type
```
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.
      
      APPIUM_PYTHON: The Appium Python type.
      
      APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
      
      APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
      
      APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
      
      CALABASH: The Calabash type.
      
      INSTRUMENTATION: The Instrumentation type.
      
      UIAUTOMATION: The uiautomation type.
      
      UIAUTOMATOR: The uiautomator type.
      
      XCTEST: The XCode test type.
      
      XCTEST_UI: The XCode UI test type.
    - created
```
Date created
```
      When the suite was created.
    - status
```
String status
```
      The suite's status.
      
      Allowed values include:
      
      PENDING: A pending status.
      
      PENDING_CONCURRENCY: A pending concurrency status.
      
      PENDING_DEVICE: A pending device status.
      
      PROCESSING: A processing status.
      
      SCHEDULING: A scheduling status.
      
      PREPARING: A preparing status.
      
      RUNNING: A running status.
      
      COMPLETED: A completed status.
      
      STOPPING: A stopping status.
    - result
```
String result
```
      The suite's result.
      
      Allowed values include:
      
      PENDING: A pending condition.
      
      PASSED: A passing condition.
      
      WARNED: A warning condition.
      
      FAILED: A failed condition.
      
      SKIPPED: A skipped condition.
      
      ERRORED: An error condition.
      
      STOPPED: A stopped condition.
    - started
```
Date started
```
      The suite's start time.
    - stopped
```
Date stopped
```
      The suite's stop time.
    - counters
```
Counters counters
```
      The suite's result counters.
    - message
```
String message
```
      A message about the suite's result.
    - deviceMinutes
```
DeviceMinutes deviceMinutes
```
      Represents the total (metered or unmetered) minutes used by the test suite.
- Class com.amazonaws.services.devicefarm.model.Test extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The test's ARN.
    - name
```
String name
```
      The test's name.
    - type
```
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.
      
      APPIUM_PYTHON: The Appium Python type.
      
      APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.
      
      APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.
      
      APPIUM_WEB_PYTHON: The Appium Python type for Web apps.
      
      CALABASH: The Calabash type.
      
      INSTRUMENTATION: The Instrumentation type.
      
      UIAUTOMATION: The uiautomation type.
      
      UIAUTOMATOR: The uiautomator type.
      
      XCTEST: The XCode test type.
      
      XCTEST_UI: The XCode UI test type.
    - created
```
Date created
```
      When the test was created.
    - status
```
String status
```
      The test's status.
      
      Allowed values include:
      
      PENDING: A pending status.
      
      PENDING_CONCURRENCY: A pending concurrency status.
      
      PENDING_DEVICE: A pending device status.
      
      PROCESSING: A processing status.
      
      SCHEDULING: A scheduling status.
      
      PREPARING: A preparing status.
      
      RUNNING: A running status.
      
      COMPLETED: A completed status.
      
      STOPPING: A stopping status.
    - result
```
String result
```
      The test's result.
      
      Allowed values include:
      
      PENDING: A pending condition.
      
      PASSED: A passing condition.
      
      WARNED: A warning condition.
      
      FAILED: A failed condition.
      
      SKIPPED: A skipped condition.
      
      ERRORED: An error condition.
      
      STOPPED: A stopped condition.
    - started
```
Date started
```
      The test's start time.
    - stopped
```
Date stopped
```
      The test's stop time.
    - counters
```
Counters counters
```
      The test's result counters.
    - message
```
String message
```
      A message about the test's result.
    - deviceMinutes
```
DeviceMinutes deviceMinutes
```
      Represents the total (metered or unmetered) minutes used by the test.
- Class com.amazonaws.services.devicefarm.model.UniqueProblem extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      A message about the unique problems' result.
    - problems
```
List<E> problems
```
      Information about the problems.
- Class com.amazonaws.services.devicefarm.model.UpdateDevicePoolRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.
    - name
```
String name
```
      A string representing the name of the device pool you wish to update.
    - description
```
String description
```
      A description of the device pool you wish to update.
    - rules
```
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.
- Class com.amazonaws.services.devicefarm.model.UpdateDevicePoolResult extends Object implements Serializable
  - Serialized Fields
    - devicePool
```
DevicePool devicePool
```
- Class com.amazonaws.services.devicefarm.model.UpdateProjectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the project whose name you wish to update.
    - name
```
String name
```
      A string representing the new name of the project that you are updating.
- Class com.amazonaws.services.devicefarm.model.UpdateProjectResult extends Object implements Serializable
  - Serialized Fields
    - project
```
Project project
```
- Class com.amazonaws.services.devicefarm.model.Upload extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The upload's ARN.
    - name
```
String name
```
      The upload's file name.
    - created
```
Date created
```
      When the upload was created.
    - type
```
String type
```
      The upload's type.
      
      Must be one of the following values:
      
      ANDROID_APP: An Android upload.
      
      IOS_APP: An iOS upload.
      
      WEB_APP: A web appliction 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.
      
      APPIUM_PYTHON_TEST_PACKAGE: An Appium Python 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.
      
      APPIUM_WEB_PYTHON_TEST_PACKAGE: An Appium Python test package upload.
      
      CALABASH_TEST_PACKAGE: A Calabash test package upload.
      
      INSTRUMENTATION_TEST_PACKAGE: An instrumentation upload.
      
      UIAUTOMATION_TEST_PACKAGE: A uiautomation test package upload.
      
      UIAUTOMATOR_TEST_PACKAGE: A uiautomator test package upload.
      
      XCTEST_TEST_PACKAGE: An XCode test package upload.
      
      XCTEST_UI_TEST_PACKAGE: An XCode UI test package upload.
    - status
```
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.
    - url
```
String url
```
      The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.
    - metadata
```
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.
    - contentType
```
String contentType
```
      The upload's content type (for example, "application/octet-stream").
    - message
```
String message
```
      A message about the upload's result.
Package com.amazonaws.services.directconnect.model
- Class com.amazonaws.services.directconnect.model.AllocateConnectionOnInterconnectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - bandwidth
```
String bandwidth
```
      Bandwidth of the connection.
      
      Example: "500Mbps"
      
      Default: None
    - connectionName
```
String connectionName
```
      Name of the provisioned connection.
      
      Example: "500M Connection to AWS"
      
      Default: None
    - ownerAccount
```
String ownerAccount
```
      Numeric account Id of the customer for whom the connection will be provisioned.
      
      Example: 123443215678
      
      Default: None
    - interconnectId
```
String interconnectId
```
      ID of the interconnect on which the connection will be provisioned.
      
      Example: dxcon-456abc78
      
      Default: None
    - vlan
```
Integer vlan
```
      The dedicated VLAN provisioned to the connection.
      
      Example: 101
      
      Default: None
- Class com.amazonaws.services.directconnect.model.AllocateConnectionOnInterconnectResult extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - connectionId
```
String connectionId
```
    - connectionName
```
String connectionName
```
    - connectionState
```
String connectionState
```
    - region
```
String region
```
    - location
```
String location
```
    - bandwidth
```
String bandwidth
```
      Bandwidth of the connection.
      
      Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
      
      Default: None
    - vlan
```
Integer vlan
```
    - partnerName
```
String partnerName
```
- Class com.amazonaws.services.directconnect.model.AllocatePrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
      The connection ID on which the private virtual interface is provisioned.
      
      Default: None
    - ownerAccount
```
String ownerAccount
```
      The AWS account that will own the new private virtual interface.
      
      Default: None
    - newPrivateVirtualInterfaceAllocation
```
NewPrivateVirtualInterfaceAllocation newPrivateVirtualInterfaceAllocation
```
      Detailed information for the private virtual interface to be provisioned.
      
      Default: None
- Class com.amazonaws.services.directconnect.model.AllocatePrivateVirtualInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - virtualInterfaceId
```
String virtualInterfaceId
```
    - location
```
String location
```
    - connectionId
```
String connectionId
```
    - virtualInterfaceType
```
String virtualInterfaceType
```
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - virtualInterfaceState
```
String virtualInterfaceState
```
    - customerRouterConfig
```
String customerRouterConfig
```
      Information for generating the customer router configuration.
    - virtualGatewayId
```
String virtualGatewayId
```
    - routeFilterPrefixes
```
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
```
- Class com.amazonaws.services.directconnect.model.AllocatePublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
      The connection ID on which the public virtual interface is provisioned.
      
      Default: None
    - ownerAccount
```
String ownerAccount
```
      The AWS account that will own the new public virtual interface.
      
      Default: None
    - newPublicVirtualInterfaceAllocation
```
NewPublicVirtualInterfaceAllocation newPublicVirtualInterfaceAllocation
```
      Detailed information for the public virtual interface to be provisioned.
      
      Default: None
- Class com.amazonaws.services.directconnect.model.AllocatePublicVirtualInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - virtualInterfaceId
```
String virtualInterfaceId
```
    - location
```
String location
```
    - connectionId
```
String connectionId
```
    - virtualInterfaceType
```
String virtualInterfaceType
```
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - virtualInterfaceState
```
String virtualInterfaceState
```
    - customerRouterConfig
```
String customerRouterConfig
```
      Information for generating the customer router configuration.
    - virtualGatewayId
```
String virtualGatewayId
```
    - routeFilterPrefixes
```
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
```
- Class com.amazonaws.services.directconnect.model.ConfirmConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
- Class com.amazonaws.services.directconnect.model.ConfirmConnectionResult extends Object implements Serializable
  - Serialized Fields
    - connectionState
```
String connectionState
```
- Class com.amazonaws.services.directconnect.model.ConfirmPrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - virtualInterfaceId
```
String virtualInterfaceId
```
    - virtualGatewayId
```
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
- Class com.amazonaws.services.directconnect.model.ConfirmPrivateVirtualInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaceState
```
String virtualInterfaceState
```
- Class com.amazonaws.services.directconnect.model.ConfirmPublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - virtualInterfaceId
```
String virtualInterfaceId
```
- Class com.amazonaws.services.directconnect.model.ConfirmPublicVirtualInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaceState
```
String virtualInterfaceState
```
- Class com.amazonaws.services.directconnect.model.Connection extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - connectionId
```
String connectionId
```
    - connectionName
```
String connectionName
```
    - connectionState
```
String connectionState
```
    - region
```
String region
```
    - location
```
String location
```
    - bandwidth
```
String bandwidth
```
      Bandwidth of the connection.
      
      Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
      
      Default: None
    - vlan
```
Integer vlan
```
    - partnerName
```
String partnerName
```
- Class com.amazonaws.services.directconnect.model.CreateConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - location
```
String location
```
    - bandwidth
```
String bandwidth
```
    - connectionName
```
String connectionName
```
- Class com.amazonaws.services.directconnect.model.CreateConnectionResult extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - connectionId
```
String connectionId
```
    - connectionName
```
String connectionName
```
    - connectionState
```
String connectionState
```
    - region
```
String region
```
    - location
```
String location
```
    - bandwidth
```
String bandwidth
```
      Bandwidth of the connection.
      
      Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
      
      Default: None
    - vlan
```
Integer vlan
```
    - partnerName
```
String partnerName
```
- Class com.amazonaws.services.directconnect.model.CreateInterconnectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - interconnectName
```
String interconnectName
```
      The name of the interconnect.
      
      Example: "1G Interconnect to AWS"
      
      Default: None
    - bandwidth
```
String bandwidth
```
      The port bandwidth
      
      Example: 1Gbps
      
      Default: None
      
      Available values: 1Gbps,10Gbps
    - location
```
String location
```
      Where the interconnect is located
      
      Example: EqSV5
      
      Default: None
- Class com.amazonaws.services.directconnect.model.CreateInterconnectResult extends Object implements Serializable
  - Serialized Fields
    - interconnectId
```
String interconnectId
```
    - interconnectName
```
String interconnectName
```
    - interconnectState
```
String interconnectState
```
    - region
```
String region
```
    - location
```
String location
```
    - bandwidth
```
String bandwidth
```
- Class com.amazonaws.services.directconnect.model.CreatePrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
    - newPrivateVirtualInterface
```
NewPrivateVirtualInterface newPrivateVirtualInterface
```
      Detailed information for the private virtual interface to be created.
      
      Default: None
- Class com.amazonaws.services.directconnect.model.CreatePrivateVirtualInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - virtualInterfaceId
```
String virtualInterfaceId
```
    - location
```
String location
```
    - connectionId
```
String connectionId
```
    - virtualInterfaceType
```
String virtualInterfaceType
```
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - virtualInterfaceState
```
String virtualInterfaceState
```
    - customerRouterConfig
```
String customerRouterConfig
```
      Information for generating the customer router configuration.
    - virtualGatewayId
```
String virtualGatewayId
```
    - routeFilterPrefixes
```
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
```
- Class com.amazonaws.services.directconnect.model.CreatePublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
    - newPublicVirtualInterface
```
NewPublicVirtualInterface newPublicVirtualInterface
```
      Detailed information for the public virtual interface to be created.
      
      Default: None
- Class com.amazonaws.services.directconnect.model.CreatePublicVirtualInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - virtualInterfaceId
```
String virtualInterfaceId
```
    - location
```
String location
```
    - connectionId
```
String connectionId
```
    - virtualInterfaceType
```
String virtualInterfaceType
```
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - virtualInterfaceState
```
String virtualInterfaceState
```
    - customerRouterConfig
```
String customerRouterConfig
```
      Information for generating the customer router configuration.
    - virtualGatewayId
```
String virtualGatewayId
```
    - routeFilterPrefixes
```
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
```
- Class com.amazonaws.services.directconnect.model.DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
- Class com.amazonaws.services.directconnect.model.DeleteConnectionResult extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - connectionId
```
String connectionId
```
    - connectionName
```
String connectionName
```
    - connectionState
```
String connectionState
```
    - region
```
String region
```
    - location
```
String location
```
    - bandwidth
```
String bandwidth
```
      Bandwidth of the connection.
      
      Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)
      
      Default: None
    - vlan
```
Integer vlan
```
    - partnerName
```
String partnerName
```
- Class com.amazonaws.services.directconnect.model.DeleteInterconnectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - interconnectId
```
String interconnectId
```
- Class com.amazonaws.services.directconnect.model.DeleteInterconnectResult extends Object implements Serializable
  - Serialized Fields
    - interconnectState
```
String interconnectState
```
- Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - virtualInterfaceId
```
String virtualInterfaceId
```
- Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaceState
```
String virtualInterfaceState
```
- Class com.amazonaws.services.directconnect.model.DescribeConnectionsOnInterconnectRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - interconnectId
```
String interconnectId
```
      ID of the interconnect on which a list of connection is provisioned.
      
      Example: dxcon-abc123
      
      Default: None
- Class com.amazonaws.services.directconnect.model.DescribeConnectionsOnInterconnectResult extends Object implements Serializable
  - Serialized Fields
    - connections
```
com.amazonaws.internal.SdkInternalList<T> connections
```
      A list of connections.
- Class com.amazonaws.services.directconnect.model.DescribeConnectionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
- Class com.amazonaws.services.directconnect.model.DescribeConnectionsResult extends Object implements Serializable
  - Serialized Fields
    - connections
```
com.amazonaws.internal.SdkInternalList<T> connections
```
      A list of connections.
- Class com.amazonaws.services.directconnect.model.DescribeInterconnectsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - interconnectId
```
String interconnectId
```
- Class com.amazonaws.services.directconnect.model.DescribeInterconnectsResult extends Object implements Serializable
  - Serialized Fields
    - interconnects
```
com.amazonaws.internal.SdkInternalList<T> interconnects
```
      A list of interconnects.
- Class com.amazonaws.services.directconnect.model.DescribeLocationsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.directconnect.model.DescribeLocationsResult extends Object implements Serializable
  - Serialized Fields
    - locations
```
com.amazonaws.internal.SdkInternalList<T> locations
```
      A list of colocation hubs where network providers have equipment. Most regions have multiple locations available.
- Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysResult extends Object implements Serializable
  - Serialized Fields
    - virtualGateways
```
com.amazonaws.internal.SdkInternalList<T> virtualGateways
```
      A list of virtual private gateways.
- Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - connectionId
```
String connectionId
```
    - virtualInterfaceId
```
String virtualInterfaceId
```
- Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesResult extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaces
```
com.amazonaws.internal.SdkInternalList<T> virtualInterfaces
```
      A list of virtual interfaces.
- Class com.amazonaws.services.directconnect.model.DirectConnectClientException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.directconnect.model.DirectConnectServerException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.directconnect.model.Interconnect extends Object implements Serializable
  - Serialized Fields
    - interconnectId
```
String interconnectId
```
    - interconnectName
```
String interconnectName
```
    - interconnectState
```
String interconnectState
```
    - region
```
String region
```
    - location
```
String location
```
    - bandwidth
```
String bandwidth
```
- Class com.amazonaws.services.directconnect.model.Location extends Object implements Serializable
  - Serialized Fields
    - locationCode
```
String locationCode
```
      The code used to indicate the AWS Direct Connect location.
    - locationName
```
String locationName
```
      The name of the AWS Direct Connect location. The name includes the colocation partner name and the physical site of the lit building.
- Class com.amazonaws.services.directconnect.model.NewPrivateVirtualInterface extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - virtualGatewayId
```
String virtualGatewayId
```
- Class com.amazonaws.services.directconnect.model.NewPrivateVirtualInterfaceAllocation extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
- Class com.amazonaws.services.directconnect.model.NewPublicVirtualInterface extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - routeFilterPrefixes
```
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
```
- Class com.amazonaws.services.directconnect.model.NewPublicVirtualInterfaceAllocation extends Object implements Serializable
  - Serialized Fields
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - routeFilterPrefixes
```
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
```
- Class com.amazonaws.services.directconnect.model.RouteFilterPrefix extends Object implements Serializable
  - Serialized Fields
    - cidr
```
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
- Class com.amazonaws.services.directconnect.model.VirtualGateway extends Object implements Serializable
  - Serialized Fields
    - virtualGatewayId
```
String virtualGatewayId
```
    - virtualGatewayState
```
String virtualGatewayState
```
- Class com.amazonaws.services.directconnect.model.VirtualInterface extends Object implements Serializable
  - Serialized Fields
    - ownerAccount
```
String ownerAccount
```
    - virtualInterfaceId
```
String virtualInterfaceId
```
    - location
```
String location
```
    - connectionId
```
String connectionId
```
    - virtualInterfaceType
```
String virtualInterfaceType
```
    - virtualInterfaceName
```
String virtualInterfaceName
```
    - vlan
```
Integer vlan
```
    - asn
```
Integer asn
```
    - authKey
```
String authKey
```
    - amazonAddress
```
String amazonAddress
```
    - customerAddress
```
String customerAddress
```
    - virtualInterfaceState
```
String virtualInterfaceState
```
    - customerRouterConfig
```
String customerRouterConfig
```
      Information for generating the customer router configuration.
    - virtualGatewayId
```
String virtualGatewayId
```
    - routeFilterPrefixes
```
com.amazonaws.internal.SdkInternalList<T> routeFilterPrefixes
```
Package com.amazonaws.services.directory.model
- Class com.amazonaws.services.directory.model.Attribute extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the attribute.
    - value
```
String value
```
      The value of the attribute.
- Class com.amazonaws.services.directory.model.AuthenticationFailedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
      The identifier of the request that caused the exception.
- Class com.amazonaws.services.directory.model.ClientException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.Computer extends Object implements Serializable
  - Serialized Fields
    - computerId
```
String computerId
```
      The identifier of the computer.
    - computerName
```
String computerName
```
      The computer name.
    - computerAttributes
```
com.amazonaws.internal.SdkInternalList<T> computerAttributes
```
      An array of Attribute objects containing the LDAP attributes that belong to the computer account.
- Class com.amazonaws.services.directory.model.ConditionalForwarder extends Object implements Serializable
  - Serialized Fields
    - remoteDomainName
```
String remoteDomainName
```
      The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.
    - dnsIpAddrs
```
com.amazonaws.internal.SdkInternalList<T> dnsIpAddrs
```
      The IP addresses of the remote DNS server associated with RemoteDomainName. This is the IP address of the DNS server that your conditional forwarder points to.
    - replicationScope
```
String replicationScope
```
      The replication scope of the conditional forwarder. The only allowed value is Domain, which will replicate the conditional forwarder to all of the domain controllers for your AWS directory.
- Class com.amazonaws.services.directory.model.ConnectDirectoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The fully-qualified name of the on-premises directory, such as corp.example.com.
    - shortName
```
String shortName
```
      The NetBIOS name of the on-premises directory, such as CORP.
    - password
```
String password
```
      The password for the on-premises user account.
    - description
```
String description
```
      A textual description for the directory.
    - size
```
String size
```
      The size of the directory.
    - connectSettings
```
DirectoryConnectSettings connectSettings
```
      A DirectoryConnectSettings object that contains additional information for the operation.
- Class com.amazonaws.services.directory.model.ConnectDirectoryResult extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the new directory.
- Class com.amazonaws.services.directory.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory for which to create the alias.
    - alias
```
String alias
```
      The requested alias.
      
      The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.
- Class com.amazonaws.services.directory.model.CreateAliasResult extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory.
    - alias
```
String alias
```
      The alias for the directory.
- Class com.amazonaws.services.directory.model.CreateComputerRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory in which to create the computer account.
    - computerName
```
String computerName
```
      The name of the computer account.
    - password
```
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.
    - organizationalUnitDistinguishedName
```
String organizationalUnitDistinguishedName
```
      The fully-qualified distinguished name of the organizational unit to place the computer account in.
    - computerAttributes
```
com.amazonaws.internal.SdkInternalList<T> computerAttributes
```
      An array of Attribute objects that contain any LDAP attributes to apply to the computer account.
- Class com.amazonaws.services.directory.model.CreateComputerResult extends Object implements Serializable
  - Serialized Fields
    - computer
```
Computer computer
```
      A Computer object that represents the computer account.
- Class com.amazonaws.services.directory.model.CreateConditionalForwarderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory ID of the AWS directory for which you are creating the conditional forwarder.
    - remoteDomainName
```
String remoteDomainName
```
      The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
    - dnsIpAddrs
```
com.amazonaws.internal.SdkInternalList<T> dnsIpAddrs
```
      The IP addresses of the remote DNS server associated with RemoteDomainName.
- Class com.amazonaws.services.directory.model.CreateConditionalForwarderResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.CreateDirectoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The fully qualified name for the directory, such as corp.example.com.
    - shortName
```
String shortName
```
      The short name of the directory, such as CORP.
    - password
```
String password
```
      The password for the directory administrator. The directory creation process creates a directory administrator account with the username Administrator and this password.
    - description
```
String description
```
      A textual description for the directory.
    - size
```
String size
```
      The size of the directory.
    - vpcSettings
```
DirectoryVpcSettings vpcSettings
```
      A DirectoryVpcSettings object that contains additional information for the operation.
- Class com.amazonaws.services.directory.model.CreateDirectoryResult extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory that was created.
- Class com.amazonaws.services.directory.model.CreateMicrosoftADRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
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.
    - shortName
```
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.
    - password
```
String password
```
      The password for the default administrative user named Admin .
    - description
```
String description
```
      A textual description for the directory. This label will appear on the AWS console Directory Details page after the directory is created.
    - vpcSettings
```
DirectoryVpcSettings vpcSettings
```
- Class com.amazonaws.services.directory.model.CreateMicrosoftADResult extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory that was created.
- Class com.amazonaws.services.directory.model.CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory of which to take a snapshot.
    - name
```
String name
```
      The descriptive name to apply to the snapshot.
- Class com.amazonaws.services.directory.model.CreateSnapshotResult extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The identifier of the snapshot that was created.
- Class com.amazonaws.services.directory.model.CreateTrustRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The Directory ID of the Microsoft AD in the AWS cloud for which to establish the trust relationship.
    - remoteDomainName
```
String remoteDomainName
```
      The Fully Qualified Domain Name (FQDN) of the external domain for which to create the trust relationship.
    - trustPassword
```
String trustPassword
```
      The trust password. The must be the same password that was used when creating the trust relationship on the external domain.
    - trustDirection
```
String trustDirection
```
      The direction of the trust relationship.
    - trustType
```
String trustType
```
      The trust relationship type.
    - conditionalForwarderIpAddrs
```
com.amazonaws.internal.SdkInternalList<T> conditionalForwarderIpAddrs
```
- Class com.amazonaws.services.directory.model.CreateTrustResult extends Object implements Serializable
  - Serialized Fields
    - trustId
```
String trustId
```
      A unique identifier for the trust relationship that was created.
- Class com.amazonaws.services.directory.model.DeleteConditionalForwarderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory ID for which you are deleting the conditional forwarder.
    - remoteDomainName
```
String remoteDomainName
```
      The fully qualified domain name (FQDN) of the remote domain with which you are deleting the conditional forwarder.
- Class com.amazonaws.services.directory.model.DeleteConditionalForwarderResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.DeleteDirectoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory to delete.
- Class com.amazonaws.services.directory.model.DeleteDirectoryResult extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory identifier.
- Class com.amazonaws.services.directory.model.DeleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The identifier of the directory snapshot to be deleted.
- Class com.amazonaws.services.directory.model.DeleteSnapshotResult extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The identifier of the directory snapshot that was deleted.
- Class com.amazonaws.services.directory.model.DeleteTrustRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - trustId
```
String trustId
```
      The Trust ID of the trust relationship to be deleted.
    - deleteAssociatedConditionalForwarder
```
Boolean deleteAssociatedConditionalForwarder
```
- Class com.amazonaws.services.directory.model.DeleteTrustResult extends Object implements Serializable
  - Serialized Fields
    - trustId
```
String trustId
```
      The Trust ID of the trust relationship that was deleted.
- Class com.amazonaws.services.directory.model.DeregisterEventTopicRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The Directory ID to remove as a publisher. This directory will no longer send messages to the specified SNS topic.
    - topicName
```
String topicName
```
      The name of the SNS topic from which to remove the directory as a publisher.
- Class com.amazonaws.services.directory.model.DeregisterEventTopicResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.DescribeConditionalForwardersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory ID for which to get the list of associated conditional forwarders.
    - remoteDomainNames
```
com.amazonaws.internal.SdkInternalList<T> remoteDomainNames
```
      The fully qualified domain names (FQDN) of the remote domains for which to get the list of associated conditional forwarders. If this member is null, all conditional forwarders are returned.
- Class com.amazonaws.services.directory.model.DescribeConditionalForwardersResult extends Object implements Serializable
  - Serialized Fields
    - conditionalForwarders
```
com.amazonaws.internal.SdkInternalList<T> conditionalForwarders
```
      The list of conditional forwarders that have been created.
- Class com.amazonaws.services.directory.model.DescribeDirectoriesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryIds
```
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.
    - nextToken
```
String nextToken
```
      The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.
    - limit
```
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.
- Class com.amazonaws.services.directory.model.DescribeDirectoriesResult extends Object implements Serializable
  - Serialized Fields
    - directoryDescriptions
```
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.
    - nextToken
```
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.
- Class com.amazonaws.services.directory.model.DescribeEventTopicsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The Directory ID for which to get the list of associated SNS topics. If this member is null, associations for all Directory IDs are returned.
    - topicNames
```
com.amazonaws.internal.SdkInternalList<T> topicNames
```
      A list of SNS topic names for which to obtain the information. If this member is null, all associations for the specified Directory ID are returned.
      
      An empty list results in an InvalidParameterException being thrown.
- Class com.amazonaws.services.directory.model.DescribeEventTopicsResult extends Object implements Serializable
  - Serialized Fields
    - eventTopics
```
com.amazonaws.internal.SdkInternalList<T> eventTopics
```
      A list of SNS topic names that receive status messages from the specified Directory ID.
- Class com.amazonaws.services.directory.model.DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory for which to retrieve snapshot information.
    - snapshotIds
```
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.
    - nextToken
```
String nextToken
```
      The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.
    - limit
```
Integer limit
```
      The maximum number of objects to return.
- Class com.amazonaws.services.directory.model.DescribeSnapshotsResult extends Object implements Serializable
  - Serialized Fields
    - snapshots
```
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.
    - nextToken
```
String nextToken
```
      If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.
- Class com.amazonaws.services.directory.model.DescribeTrustsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The Directory ID of the AWS directory that is a part of the requested trust relationship.
    - trustIds
```
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.
    - nextToken
```
String nextToken
```
      The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.
    - limit
```
Integer limit
```
      The maximum number of objects to return.
- Class com.amazonaws.services.directory.model.DescribeTrustsResult extends Object implements Serializable
  - Serialized Fields
    - trusts
```
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.
    - nextToken
```
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.
- Class com.amazonaws.services.directory.model.DirectoryConnectSettings extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The identifier of the VPC in which the AD Connector is created.
    - subnetIds
```
com.amazonaws.internal.SdkInternalList<T> subnetIds
```
      A list of subnet identifiers in the VPC in which the AD Connector is created.
    - customerDnsIps
```
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.
    - customerUserName
```
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:
      
      Read users and groups
      
      Create computer objects
      
      Join computers to the domain
- Class com.amazonaws.services.directory.model.DirectoryConnectSettingsDescription extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The identifier of the VPC that the AD Connector is in.
    - subnetIds
```
com.amazonaws.internal.SdkInternalList<T> subnetIds
```
      A list of subnet identifiers in the VPC that the AD connector is in.
    - customerUserName
```
String customerUserName
```
      The username of the service account in the on-premises directory.
    - securityGroupId
```
String securityGroupId
```
      The security group identifier for the AD Connector directory.
    - availabilityZones
```
com.amazonaws.internal.SdkInternalList<T> availabilityZones
```
      A list of the Availability Zones that the directory is in.
    - connectIps
```
com.amazonaws.internal.SdkInternalList<T> connectIps
```
      The IP addresses of the AD Connector servers.
- Class com.amazonaws.services.directory.model.DirectoryDescription extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory identifier.
    - name
```
String name
```
      The fully-qualified name of the directory.
    - shortName
```
String shortName
```
      The short name of the directory.
    - size
```
String size
```
      The directory size.
    - alias
```
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.
    - accessUrl
```
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.
    - description
```
String description
```
      The textual description for the directory.
    - dnsIpAddrs
```
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.
    - stage
```
String stage
```
      The current stage of the directory.
    - launchTime
```
Date launchTime
```
      Specifies when the directory was created.
    - stageLastUpdatedDateTime
```
Date stageLastUpdatedDateTime
```
      The date and time that the stage was last updated.
    - type
```
String type
```
      The directory size.
    - vpcSettings
```
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.
    - connectSettings
```
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 radiusSettings
```
      A RadiusSettings object that contains information about the RADIUS server configured for this directory.
    - radiusStatus
```
String radiusStatus
```
      The status of the RADIUS MFA server connection.
    - stageReason
```
String stageReason
```
      Additional information about the directory stage.
    - ssoEnabled
```
Boolean ssoEnabled
```
      Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.
- Class com.amazonaws.services.directory.model.DirectoryLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.DirectoryLimits extends Object implements Serializable
  - Serialized Fields
    - cloudOnlyDirectoriesLimit
```
Integer cloudOnlyDirectoriesLimit
```
      The maximum number of cloud directories allowed in the region.
    - cloudOnlyDirectoriesCurrentCount
```
Integer cloudOnlyDirectoriesCurrentCount
```
      The current number of cloud directories in the region.
    - cloudOnlyDirectoriesLimitReached
```
Boolean cloudOnlyDirectoriesLimitReached
```
      Indicates if the cloud directory limit has been reached.
    - cloudOnlyMicrosoftADLimit
```
Integer cloudOnlyMicrosoftADLimit
```
      The maximum number of Microsoft AD directories allowed in the region.
    - cloudOnlyMicrosoftADCurrentCount
```
Integer cloudOnlyMicrosoftADCurrentCount
```
      The current number of Microsoft AD directories in the region.
    - cloudOnlyMicrosoftADLimitReached
```
Boolean cloudOnlyMicrosoftADLimitReached
```
      Indicates if the Microsoft AD directory limit has been reached.
    - connectedDirectoriesLimit
```
Integer connectedDirectoriesLimit
```
      The maximum number of connected directories allowed in the region.
    - connectedDirectoriesCurrentCount
```
Integer connectedDirectoriesCurrentCount
```
      The current number of connected directories in the region.
    - connectedDirectoriesLimitReached
```
Boolean connectedDirectoriesLimitReached
```
      Indicates if the connected directory limit has been reached.
- Class com.amazonaws.services.directory.model.DirectoryUnavailableException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.DirectoryVpcSettings extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The identifier of the VPC in which to create the directory.
    - subnetIds
```
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.
- Class com.amazonaws.services.directory.model.DirectoryVpcSettingsDescription extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The identifier of the VPC that the directory is in.
    - subnetIds
```
com.amazonaws.internal.SdkInternalList<T> subnetIds
```
      The identifiers of the subnets for the directory servers.
    - securityGroupId
```
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.
    - availabilityZones
```
com.amazonaws.internal.SdkInternalList<T> availabilityZones
```
      The list of Availability Zones that the directory is in.
- Class com.amazonaws.services.directory.model.DisableRadiusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory for which to disable MFA.
- Class com.amazonaws.services.directory.model.DisableRadiusResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.DisableSsoRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory for which to disable single-sign on.
    - userName
```
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.
    - password
```
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.
- Class com.amazonaws.services.directory.model.DisableSsoResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.EnableRadiusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory for which to enable MFA.
    - radiusSettings
```
RadiusSettings radiusSettings
```
      A RadiusSettings object that contains information about the RADIUS server.
- Class com.amazonaws.services.directory.model.EnableRadiusResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.EnableSsoRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory for which to enable single-sign on.
    - userName
```
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.
    - password
```
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.
- Class com.amazonaws.services.directory.model.EnableSsoResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.EntityAlreadyExistsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.EntityDoesNotExistException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.EventTopic extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.
    - topicName
```
String topicName
```
      The name of an AWS SNS topic the receives status messages from the directory.
    - topicArn
```
String topicArn
```
      The SNS topic ARN (Amazon Resource Name).
    - createdDateTime
```
Date createdDateTime
```
      The date and time of when you associated your directory with the SNS topic.
    - status
```
String status
```
      The topic registration status.
- Class com.amazonaws.services.directory.model.GetDirectoryLimitsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.directory.model.GetDirectoryLimitsResult extends Object implements Serializable
  - Serialized Fields
    - directoryLimits
```
DirectoryLimits directoryLimits
```
      A DirectoryLimits object that contains the directory limits for the current region.
- Class com.amazonaws.services.directory.model.GetSnapshotLimitsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      Contains the identifier of the directory to obtain the limits for.
- Class com.amazonaws.services.directory.model.GetSnapshotLimitsResult extends Object implements Serializable
  - Serialized Fields
    - snapshotLimits
```
SnapshotLimits snapshotLimits
```
      A SnapshotLimits object that contains the manual snapshot limits for the specified directory.
- Class com.amazonaws.services.directory.model.InsufficientPermissionsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.InvalidNextTokenException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.InvalidParameterException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.RadiusSettings extends Object implements Serializable
  - Serialized Fields
    - radiusServers
```
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.
    - radiusPort
```
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.
    - radiusTimeout
```
Integer radiusTimeout
```
      The amount of time, in seconds, to wait for the RADIUS server to respond.
    - radiusRetries
```
Integer radiusRetries
```
      The maximum number of times that communication with the RADIUS server is attempted.
    - sharedSecret
```
String sharedSecret
```
      The shared secret code that was specified when your RADIUS endpoints were created.
    - authenticationProtocol
```
String authenticationProtocol
```
      The protocol specified for your RADIUS endpoints.
    - displayLabel
```
String displayLabel
```
      Not currently used.
    - useSameUsername
```
Boolean useSameUsername
```
      Not currently used.
- Class com.amazonaws.services.directory.model.RegisterEventTopicRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The Directory ID that will publish status messages to the SNS topic.
    - topicName
```
String topicName
```
      The SNS topic name to which the directory will publish status messages. This SNS topic must be in the same region as the specified Directory ID.
- Class com.amazonaws.services.directory.model.RegisterEventTopicResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.RestoreFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The identifier of the snapshot to restore from.
- Class com.amazonaws.services.directory.model.RestoreFromSnapshotResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.ServiceException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.Snapshot extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory identifier.
    - snapshotId
```
String snapshotId
```
      The snapshot identifier.
    - type
```
String type
```
      The snapshot type.
    - name
```
String name
```
      The descriptive name of the snapshot.
    - status
```
String status
```
      The snapshot status.
    - startTime
```
Date startTime
```
      The date and time that the snapshot was taken.
- Class com.amazonaws.services.directory.model.SnapshotLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.SnapshotLimits extends Object implements Serializable
  - Serialized Fields
    - manualSnapshotsLimit
```
Integer manualSnapshotsLimit
```
      The maximum number of manual snapshots allowed.
    - manualSnapshotsCurrentCount
```
Integer manualSnapshotsCurrentCount
```
      The current number of manual snapshots of the directory.
    - manualSnapshotsLimitReached
```
Boolean manualSnapshotsLimitReached
```
      Indicates if the manual snapshot limit has been reached.
- Class com.amazonaws.services.directory.model.Trust extends Object implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The Directory ID of the AWS directory involved in the trust relationship.
    - trustId
```
String trustId
```
      The unique ID of the trust relationship.
    - remoteDomainName
```
String remoteDomainName
```
      The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.
    - trustType
```
String trustType
```
      The trust relationship type.
    - trustDirection
```
String trustDirection
```
      The trust relationship direction.
    - trustState
```
String trustState
```
      The trust relationship state.
    - createdDateTime
```
Date createdDateTime
```
      The date and time that the trust relationship was created.
    - lastUpdatedDateTime
```
Date lastUpdatedDateTime
```
      The date and time that the trust relationship was last updated.
    - stateLastUpdatedDateTime
```
Date stateLastUpdatedDateTime
```
      The date and time that the TrustState was last updated.
    - trustStateReason
```
String trustStateReason
```
      The reason for the TrustState.
- Class com.amazonaws.services.directory.model.UnsupportedOperationException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - requestId
```
String requestId
```
- Class com.amazonaws.services.directory.model.UpdateConditionalForwarderRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The directory ID of the AWS directory for which to update the conditional forwarder.
    - remoteDomainName
```
String remoteDomainName
```
      The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.
    - dnsIpAddrs
```
com.amazonaws.internal.SdkInternalList<T> dnsIpAddrs
```
      The updated IP addresses of the remote DNS server associated with the conditional forwarder.
- Class com.amazonaws.services.directory.model.UpdateConditionalForwarderResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.UpdateRadiusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - directoryId
```
String directoryId
```
      The identifier of the directory for which to update the RADIUS server information.
    - radiusSettings
```
RadiusSettings radiusSettings
```
      A RadiusSettings object that contains information about the RADIUS server.
- Class com.amazonaws.services.directory.model.UpdateRadiusResult extends Object implements Serializable
- Class com.amazonaws.services.directory.model.VerifyTrustRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - trustId
```
String trustId
```
      The unique Trust ID of the trust relationship to verify.
- Class com.amazonaws.services.directory.model.VerifyTrustResult extends Object implements Serializable
  - Serialized Fields
    - trustId
```
String trustId
```
      The unique Trust ID of the trust relationship that was verified.
Package com.amazonaws.services.dynamodbv2.datamodeling
- Class com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMappingException extends RuntimeException implements Serializable
  
  serialVersionUID:
  
  -4883173289978517967L
Package com.amazonaws.services.dynamodbv2.document
- Class com.amazonaws.services.dynamodbv2.document.IncompatibleTypeException extends AmazonClientException implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.dynamodbv2.document.utils
- Class com.amazonaws.services.dynamodbv2.document.utils.FluentArrayList extends ArrayList<E> implements Serializable
  
  serialVersionUID:
  
  -8269850815375778149L
- Class com.amazonaws.services.dynamodbv2.document.utils.FluentHashMap extends LinkedHashMap<K,V> implements Serializable
  
  serialVersionUID:
  
  4857340227048063855L
- Class com.amazonaws.services.dynamodbv2.document.utils.FluentHashSet extends LinkedHashSet<E> implements Serializable
  
  serialVersionUID:
  
  -549868294257559427L
- Class com.amazonaws.services.dynamodbv2.document.utils.NameMap extends FluentHashMap<String,String> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.document.utils.ValueList extends FluentArrayList<Object> implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.document.utils.ValueMap extends FluentHashMap<String,Object> implements Serializable
  
  serialVersionUID:
  
  1L
Package com.amazonaws.services.dynamodbv2.model
- Class com.amazonaws.services.dynamodbv2.model.AttributeDefinition extends Object implements Serializable
  - Serialized Fields
    - attributeName
```
String attributeName
```
      A name for the attribute.
    - attributeType
```
String attributeType
```
      The data type for the attribute, where:
      
      S - the attribute is of type String
      
      N - the attribute is of type Number
      
      B - the attribute is of type Binary
- Class com.amazonaws.services.dynamodbv2.model.AttributeValue extends Object implements Serializable
  - Serialized Fields
    - s
```
String s
```
      A String data type.
    - n
```
String n
```
      A Number data type.
    - b
```
ByteBuffer b
```
      A Binary data type.
    - sS
```
List<E> sS
```
      A String Set data type.
    - nS
```
List<E> nS
```
      A Number Set data type.
    - bS
```
List<E> bS
```
      A Binary Set data type.
    - m
```
Map<K,V> m
```
      A Map of attribute values.
    - l
```
List<E> l
```
      A List of attribute values.
    - nULLValue
```
Boolean nULLValue
```
      A Null data type.
    - bOOL
```
Boolean bOOL
```
      A Boolean data type.
- Class com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate extends Object implements Serializable
  - Serialized Fields
    - value
```
AttributeValue value
```
    - action
```
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.
- Class com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - requestItems
```
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 simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.
      
      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.
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
- Class com.amazonaws.services.dynamodbv2.model.BatchGetItemResult extends Object implements Serializable
  - Serialized Fields
    - responses
```
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.
    - unprocessedKeys
```
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.
    - consumedCapacity
```
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.
- Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - requestItems
```
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 simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
      
      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.
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
    - returnItemCollectionMetrics
```
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.
- Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemResult extends Object implements Serializable
  - Serialized Fields
    - unprocessedItems
```
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.
    - itemCollectionMetrics
```
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 partition key value of the item collection. This is the same as the partition key value 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.
    - consumedCapacity
```
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.
- Class com.amazonaws.services.dynamodbv2.model.Capacity extends Object implements Serializable
  - Serialized Fields
    - capacityUnits
```
Double capacityUnits
```
      The total number of capacity units consumed on a table or an index.
- Class com.amazonaws.services.dynamodbv2.model.Condition extends Object implements Serializable
  - Serialized Fields
    - attributeValueList
```
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.
    - comparisonOperator
```
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.
- Class com.amazonaws.services.dynamodbv2.model.ConditionalCheckFailedException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.ConsumedCapacity extends Object implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table that was affected by the operation.
    - capacityUnits
```
Double capacityUnits
```
      The total number of capacity units consumed by the operation.
    - table
```
Capacity table
```
      The amount of throughput consumed on the table affected by the operation.
    - localSecondaryIndexes
```
Map<K,V> localSecondaryIndexes
```
      The amount of throughput consumed on each local index affected by the operation.
    - globalSecondaryIndexes
```
Map<K,V> globalSecondaryIndexes
```
      The amount of throughput consumed on each global index affected by the operation.
- Class com.amazonaws.services.dynamodbv2.model.CreateGlobalSecondaryIndexAction extends Object implements Serializable
  - Serialized Fields
    - indexName
```
String indexName
```
      The name of the global secondary index to be created.
    - keySchema
```
List<E> keySchema
```
      The key schema for the global secondary index.
    - projection
```
Projection projection
```
    - provisionedThroughput
```
ProvisionedThroughput provisionedThroughput
```
- Class com.amazonaws.services.dynamodbv2.model.CreateTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attributeDefinitions
```
List<E> attributeDefinitions
```
      An array of attributes that describe the key schema for the table and indexes.
    - tableName
```
String tableName
```
      The name of the table to create.
    - keySchema
```
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 - The role that the key attribute will assume:
      
      HASH - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
      
      For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.
      
      For a composite primary key (partition key and sort key), 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.
    - localSecondaryIndexes
```
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 partition key value. There is a 10 GB size limit per partition key value; 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 partition key 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.
    - globalSecondaryIndexes
```
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 provisionedThroughput
```
    - streamSpecification
```
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.
- Class com.amazonaws.services.dynamodbv2.model.CreateTableResult extends Object implements Serializable
  - Serialized Fields
    - tableDescription
```
TableDescription tableDescription
```
- Class com.amazonaws.services.dynamodbv2.model.DeleteGlobalSecondaryIndexAction extends Object implements Serializable
  - Serialized Fields
    - indexName
```
String indexName
```
      The name of the global secondary index to be deleted.
- Class com.amazonaws.services.dynamodbv2.model.DeleteItemRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table from which to delete the item.
    - key
```
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 simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
    - expected
```
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.
    - conditionalOperator
```
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.
    - returnValues
```
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.
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
    - returnItemCollectionMetrics
```
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.
    - conditionExpression
```
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.
    - expressionAttributeNames
```
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.
    - expressionAttributeValues
```
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.
- Class com.amazonaws.services.dynamodbv2.model.DeleteItemResult extends Object implements Serializable
  - Serialized Fields
    - attributes
```
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 consumedCapacity
```
    - itemCollectionMetrics
```
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 partition key value of the item collection. This is the same as the partition key value of the item itself.
      
      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.
- Class com.amazonaws.services.dynamodbv2.model.DeleteRequest extends Object implements Serializable
  - Serialized Fields
    - key
```
Map<K,V> key
```
      A map of attribute name to attribute values, representing the primary key of the item to delete. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema.
- Class com.amazonaws.services.dynamodbv2.model.DeleteTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table to delete.
- Class com.amazonaws.services.dynamodbv2.model.DeleteTableResult extends Object implements Serializable
  - Serialized Fields
    - tableDescription
```
TableDescription tableDescription
```
- Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsResult extends Object implements Serializable
  - Serialized Fields
    - accountMaxReadCapacityUnits
```
Long accountMaxReadCapacityUnits
```
      The maximum total read capacity units that your account allows you to provision across all of your tables in this region.
    - accountMaxWriteCapacityUnits
```
Long accountMaxWriteCapacityUnits
```
      The maximum total write capacity units that your account allows you to provision across all of your tables in this region.
    - tableMaxReadCapacityUnits
```
Long tableMaxReadCapacityUnits
```
      The maximum read capacity units that your account allows you to provision for a new table that you are creating in this region, including the read capacity units provisioned for its global secondary indexes (GSIs).
    - tableMaxWriteCapacityUnits
```
Long tableMaxWriteCapacityUnits
```
      The maximum write capacity units that your account allows you to provision for a new table that you are creating in this region, including the write capacity units provisioned for its global secondary indexes (GSIs).
- Class com.amazonaws.services.dynamodbv2.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamArn
```
String streamArn
```
      The Amazon Resource Name (ARN) for the stream.
    - limit
```
Integer limit
```
      The maximum number of shard objects to return. The upper limit is 100.
    - exclusiveStartShardId
```
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.
- Class com.amazonaws.services.dynamodbv2.model.DescribeStreamResult extends Object implements Serializable
  - Serialized Fields
    - streamDescription
```
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.
- Class com.amazonaws.services.dynamodbv2.model.DescribeTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table to describe.
- Class com.amazonaws.services.dynamodbv2.model.DescribeTableResult extends Object implements Serializable
  - Serialized Fields
    - table
```
TableDescription table
```
- Class com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue extends Object implements Serializable
  - Serialized Fields
    - value
```
AttributeValue value
```
    - exists
```
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.)
    - comparisonOperator
```
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"]}
    - attributeValueList
```
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.
- Class com.amazonaws.services.dynamodbv2.model.ExpiredIteratorException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.GetItemRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table containing the requested item.
    - key
```
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 simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
    - attributesToGet
```
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.
    - consistentRead
```
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.
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
    - projectionExpression
```
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.
    - expressionAttributeNames
```
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.
- Class com.amazonaws.services.dynamodbv2.model.GetItemResult extends Object implements Serializable
  - Serialized Fields
    - item
```
Map<K,V> item
```
      A map of attribute names to AttributeValue objects, as specified by AttributesToGet.
    - consumedCapacity
```
ConsumedCapacity consumedCapacity
```
- Class com.amazonaws.services.dynamodbv2.model.GetRecordsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - shardIterator
```
String shardIterator
```
      A shard iterator that was retrieved from a previous GetShardIterator operation. This iterator can be used to access the stream records in this shard.
    - limit
```
Integer limit
```
      The maximum number of records to return from the shard. The upper limit is 1000.
- Class com.amazonaws.services.dynamodbv2.model.GetRecordsResult extends Object implements Serializable
  - Serialized Fields
    - records
```
List<E> records
```
      The stream records from the shard, which were retrieved using the shard iterator.
    - nextShardIterator
```
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.
- Class com.amazonaws.services.dynamodbv2.model.GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - streamArn
```
String streamArn
```
      The Amazon Resource Name (ARN) for the stream.
    - shardId
```
String shardId
```
      The identifier of the shard. The iterator will be returned for this shard ID.
    - shardIteratorType
```
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.
    - sequenceNumber
```
String sequenceNumber
```
      The sequence number of a stream record in the shard from which to start reading.
- Class com.amazonaws.services.dynamodbv2.model.GetShardIteratorResult extends Object implements Serializable
  - Serialized Fields
    - shardIterator
```
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.
- Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndex extends Object implements Serializable
  - Serialized Fields
    - indexName
```
String indexName
```
      The name of the global secondary index. The name must be unique among all other indexes on this table.
    - keySchema
```
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 - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    - projection
```
Projection projection
```
    - provisionedThroughput
```
ProvisionedThroughput provisionedThroughput
```
- Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexDescription extends Object implements Serializable
  - Serialized Fields
    - indexName
```
String indexName
```
      The name of the global secondary index.
    - keySchema
```
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 - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    - projection
```
Projection projection
```
    - indexStatus
```
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.
    - backfilling
```
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 partition key cannot have any duplicate values.) 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.
    - provisionedThroughput
```
ProvisionedThroughputDescription provisionedThroughput
```
    - indexSizeBytes
```
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.
    - itemCount
```
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.
    - indexArn
```
String indexArn
```
      The Amazon Resource Name (ARN) that uniquely identifies the index.
- Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexUpdate extends Object implements Serializable
  - Serialized Fields
    - update
```
UpdateGlobalSecondaryIndexAction update
```
      The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.
    - create
```
CreateGlobalSecondaryIndexAction create
```
      The parameters required for creating a global secondary index on an existing table:
      
      IndexName
      
      KeySchema
      
      AttributeDefinitions
      
      Projection
      
      ProvisionedThroughput
    - delete
```
DeleteGlobalSecondaryIndexAction delete
```
      The name of an existing global secondary index to be removed.
- Class com.amazonaws.services.dynamodbv2.model.InternalServerErrorException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics extends Object implements Serializable
  - Serialized Fields
    - itemCollectionKey
```
Map<K,V> itemCollectionKey
```
      The partition key value of the item collection. This value is the same as the partition key value of the item.
    - sizeEstimateRangeGB
```
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.
- Class com.amazonaws.services.dynamodbv2.model.ItemCollectionSizeLimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.KeysAndAttributes extends Object implements Serializable
  - Serialized Fields
    - keys
```
List<E> keys
```
      The primary key attribute values that define the items and the attributes associated with the items.
    - attributesToGet
```
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.
    - consistentRead
```
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.
    - projectionExpression
```
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.
    - expressionAttributeNames
```
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.
- Class com.amazonaws.services.dynamodbv2.model.KeySchemaElement extends Object implements Serializable
  - Serialized Fields
    - attributeName
```
String attributeName
```
      The name of a key attribute.
    - keyType
```
String keyType
```
      The role that this key attribute will assume:
      
      HASH - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
- Class com.amazonaws.services.dynamodbv2.model.LimitExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      If this parameter is provided, then only the streams associated with this table name are returned.
    - limit
```
Integer limit
```
      The maximum number of streams to return. The upper limit is 100.
    - exclusiveStartStreamArn
```
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.
- Class com.amazonaws.services.dynamodbv2.model.ListStreamsResult extends Object implements Serializable
  - Serialized Fields
    - streams
```
List<E> streams
```
      A list of stream descriptors associated with the current account and endpoint.
    - lastEvaluatedStreamArn
```
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.
- Class com.amazonaws.services.dynamodbv2.model.ListTablesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exclusiveStartTableName
```
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.
    - limit
```
Integer limit
```
      A maximum number of table names to return. If this parameter is not specified, the limit is 100.
- Class com.amazonaws.services.dynamodbv2.model.ListTablesResult extends Object implements Serializable
  - Serialized Fields
    - tableNames
```
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.
    - lastEvaluatedTableName
```
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.
- Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex extends Object implements Serializable
  - Serialized Fields
    - indexName
```
String indexName
```
      The name of the local secondary index. The name must be unique among all other indexes on this table.
    - keySchema
```
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 - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    - projection
```
Projection projection
```
- Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndexDescription extends Object implements Serializable
  - Serialized Fields
    - indexName
```
String indexName
```
      Represents the name of the local secondary index.
    - keySchema
```
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 - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
    - projection
```
Projection projection
```
    - indexSizeBytes
```
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.
    - itemCount
```
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.
    - indexArn
```
String indexArn
```
      The Amazon Resource Name (ARN) that uniquely identifies the index.
- Class com.amazonaws.services.dynamodbv2.model.Projection extends Object implements Serializable
  - Serialized Fields
    - projectionType
```
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.
    - nonKeyAttributes
```
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.
- Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput extends Object implements Serializable
  - Serialized Fields
    - readCapacityUnits
```
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.
    - writeCapacityUnits
```
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.
- Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputDescription extends Object implements Serializable
  - Serialized Fields
    - lastIncreaseDateTime
```
Date lastIncreaseDateTime
```
      The date and time of the last provisioned throughput increase for this table.
    - lastDecreaseDateTime
```
Date lastDecreaseDateTime
```
      The date and time of the last provisioned throughput decrease for this table.
    - numberOfDecreasesToday
```
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.
    - readCapacityUnits
```
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.
    - writeCapacityUnits
```
Long writeCapacityUnits
```
      The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
- Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.PutItemRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table to contain the item.
    - 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 simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.
      
      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.
    - expected
```
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.
    - returnValues
```
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.
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
    - returnItemCollectionMetrics
```
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.
    - conditionalOperator
```
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.
    - conditionExpression
```
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.
    - expressionAttributeNames
```
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.
    - expressionAttributeValues
```
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.
- Class com.amazonaws.services.dynamodbv2.model.PutItemResult extends Object implements Serializable
  - Serialized Fields
    - attributes
```
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 consumedCapacity
```
    - itemCollectionMetrics
```
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 partition key value of the item collection. This is the same as the partition key value of the item itself.
      
      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.
- Class com.amazonaws.services.dynamodbv2.model.PutRequest extends Object implements Serializable
  - Serialized Fields
    - item
```
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.
- Class com.amazonaws.services.dynamodbv2.model.QueryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table containing the requested items.
    - indexName
```
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.
    - select
```
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.
    - attributesToGet
```
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.
    - limit
```
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.
    - consistentRead
```
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.
    - keyConditions
```
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 partition key name and value as an EQ condition. You can optionally provide a second condition, referring to the sort key.
      
      If you don't provide a sort key condition, all of the items that match the partition 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 partition key name and value as an EQ condition. You can optionally provide a second condition, referring to the index sort key.
      
      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.
    - queryFilter
```
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 partition key or a sort 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.
    - conditionalOperator
```
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.
    - scanIndexForward
```
Boolean scanIndexForward
```
      Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.
      
      Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored 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 the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false , DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.
    - exclusiveStartKey
```
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.
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
    - projectionExpression
```
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.
    - filterExpression
```
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.
    - keyConditionExpression
```
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 partition key value. The condition can also perform one of several comparison tests on a single sort key value. Query can use KeyConditionExpression to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.
      
      The partition key equality test is required, and must be specified in the following format:
      
      partitionKeyName = :partitionkeyval
      
      If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:
      
      partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval
      
      Valid comparisons for the sort key condition are as follows:
      
      sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.
      
      sortKeyName :sortkeyval - true if the sort key value is less than :sortkeyval.
      
      sortKeyName = :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.
      
      sortKeyName :sortkeyval - true if the sort key value is greater than :sortkeyval.
      
      sortKeyName = :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.
      
      sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.
      
      begins_with (sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort 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 :partitionval and :sortval with actual values at runtime.
      
      You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:
      
      Size = :myval
      
      To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows:
      
      #S = :myval
      
      For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.
      
      For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.
      
      KeyConditionExpression replaces the legacy KeyConditions parameter.
    - expressionAttributeNames
```
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.
    - expressionAttributeValues
```
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.
- Class com.amazonaws.services.dynamodbv2.model.QueryResult extends Object implements Serializable
  - Serialized Fields
    - items
```
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.
    - count
```
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.
    - scannedCount
```
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.
    - lastEvaluatedKey
```
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 consumedCapacity
```
- Class com.amazonaws.services.dynamodbv2.model.Record extends Object implements Serializable
  - Serialized Fields
    - eventID
```
String eventID
```
      A globally unique identifier for the event that was recorded in this stream record.
    - eventName
```
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
    - eventVersion
```
String eventVersion
```
      The version number of the stream record format. Currently, this is 1.0.
    - eventSource
```
String eventSource
```
      The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.
    - awsRegion
```
String awsRegion
```
      The region in which the GetRecords request was received.
    - dynamodb
```
StreamRecord dynamodb
```
      The main body of the stream record, containing all of the DynamoDB-specific fields.
- Class com.amazonaws.services.dynamodbv2.model.ResourceInUseException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.ScanRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
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.
    - indexName
```
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.
    - attributesToGet
```
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.
    - limit
```
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.
    - select
```
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.)
    - scanFilter
```
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.
    - conditionalOperator
```
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.
    - exclusiveStartKey
```
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.
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
    - totalSegments
```
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.
    - 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.
    - projectionExpression
```
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.
    - filterExpression
```
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.
    - expressionAttributeNames
```
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.
    - expressionAttributeValues
```
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.
    - consistentRead
```
Boolean consistentRead
```
      A Boolean value that determines the read consistency model during the scan:
      
      If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem or DeleteItem).
      
      If ConsistentRead is true, then 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.
      
      The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.
- Class com.amazonaws.services.dynamodbv2.model.ScanResult extends Object implements Serializable
  - Serialized Fields
    - items
```
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.
    - count
```
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.
    - 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.
    - lastEvaluatedKey
```
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 consumedCapacity
```
- Class com.amazonaws.services.dynamodbv2.model.SequenceNumberRange extends Object implements Serializable
  - Serialized Fields
    - startingSequenceNumber
```
String startingSequenceNumber
```
      The first sequence number.
    - endingSequenceNumber
```
String endingSequenceNumber
```
      The last sequence number.
- Class com.amazonaws.services.dynamodbv2.model.Shard extends Object implements Serializable
  - Serialized Fields
    - shardId
```
String shardId
```
      The system-generated identifier for this shard.
    - sequenceNumberRange
```
SequenceNumberRange sequenceNumberRange
```
      The range of possible sequence numbers for the shard.
    - parentShardId
```
String parentShardId
```
      The shard ID of the current shard's parent.
- Class com.amazonaws.services.dynamodbv2.model.Stream extends Object implements Serializable
  - Serialized Fields
    - streamArn
```
String streamArn
```
      The Amazon Resource Name (ARN) for the stream.
    - tableName
```
String tableName
```
      The DynamoDB table with which the stream is associated.
    - streamLabel
```
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
- Class com.amazonaws.services.dynamodbv2.model.StreamDescription extends Object implements Serializable
  - Serialized Fields
    - streamArn
```
String streamArn
```
      The Amazon Resource Name (ARN) for the stream.
    - streamLabel
```
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
    - streamStatus
```
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.
    - streamViewType
```
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.
    - creationRequestDateTime
```
Date creationRequestDateTime
```
      The date and time when the request to create this stream was issued.
    - tableName
```
String tableName
```
      The DynamoDB table with which the stream is associated.
    - keySchema
```
List<E> keySchema
```
      The key attribute(s) of the stream's DynamoDB table.
    - shards
```
List<E> shards
```
      The shards that comprise the stream.
    - lastEvaluatedShardId
```
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.
- Class com.amazonaws.services.dynamodbv2.model.StreamRecord extends Object implements Serializable
  - Serialized Fields
    - keys
```
Map<K,V> keys
```
      The primary key attribute(s) for the DynamoDB item that was modified.
    - newImage
```
Map<K,V> newImage
```
      The item in the DynamoDB table as it appeared after it was modified.
    - oldImage
```
Map<K,V> oldImage
```
      The item in the DynamoDB table as it appeared before it was modified.
    - sequenceNumber
```
String sequenceNumber
```
      The sequence number of the stream record.
    - sizeBytes
```
Long sizeBytes
```
      The size of the stream record, in bytes.
    - streamViewType
```
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.
- Class com.amazonaws.services.dynamodbv2.model.StreamSpecification extends Object implements Serializable
  - Serialized Fields
    - streamEnabled
```
Boolean streamEnabled
```
      Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the table.
    - streamViewType
```
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.
- Class com.amazonaws.services.dynamodbv2.model.TableDescription extends Object implements Serializable
  - Serialized Fields
    - attributeDefinitions
```
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.
    - tableName
```
String tableName
```
      The name of the table.
    - keySchema
```
List<E> keySchema
```
      The primary key structure for the table. Each KeySchemaElement consists of:
      
      AttributeName - The name of the attribute.
      
      KeyType - The role of the attribute:
      .
      
      HASH - partition key
      
      RANGE - sort key
      
      The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.
      
      The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.
      
      For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
    - tableStatus
```
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.
    - creationDateTime
```
Date creationDateTime
```
      The date and time when the table was created, in UNIX epoch time format.
    - provisionedThroughput
```
ProvisionedThroughputDescription provisionedThroughput
```
      The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.
    - tableSizeBytes
```
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.
    - itemCount
```
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.
    - tableArn
```
String tableArn
```
      The Amazon Resource Name (ARN) that uniquely identifies the table.
    - localSecondaryIndexes
```
List<E> localSecondaryIndexes
```
      Represents one or more local secondary indexes on the table. Each index is scoped to a given partition 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 partition key 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.
    - globalSecondaryIndexes
```
List<E> globalSecondaryIndexes
```
      The global secondary indexes, if any, on the table. Each index is scoped to a given partition 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 partition key 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 streamSpecification
```
      The current DynamoDB Streams configuration for the table.
    - latestStreamLabel
```
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.
    - latestStreamArn
```
String latestStreamArn
```
      The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this table.
- Class com.amazonaws.services.dynamodbv2.model.TrimmedDataAccessException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalSecondaryIndexAction extends Object implements Serializable
  - Serialized Fields
    - indexName
```
String indexName
```
      The name of the global secondary index to be updated.
    - provisionedThroughput
```
ProvisionedThroughput provisionedThroughput
```
- Class com.amazonaws.services.dynamodbv2.model.UpdateItemRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - tableName
```
String tableName
```
      The name of the table containing the item to update.
    - key
```
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 simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
    - attributeUpdates
```
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 non-key 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.
    - expected
```
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.
    - conditionalOperator
```
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.
    - returnValues
```
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.
      
      There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
      
      Values returned are strongly consistent
    - returnConsumedCapacity
```
String returnConsumedCapacity
```
    - returnItemCollectionMetrics
```
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.
    - updateExpression
```
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.
    - conditionExpression
```
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.
    - expressionAttributeNames
```
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.
    - expressionAttributeValues
```
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.
- Class com.amazonaws.services.dynamodbv2.model.UpdateItemResult extends Object implements Serializable
  - Serialized Fields
    - attributes
```
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 consumedCapacity
```
    - itemCollectionMetrics
```
ItemCollectionMetrics itemCollectionMetrics
```
- Class com.amazonaws.services.dynamodbv2.model.UpdateTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attributeDefinitions
```
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.
    - tableName
```
String tableName
```
      The name of the table to be updated.
    - provisionedThroughput
```
ProvisionedThroughput provisionedThroughput
```
    - globalSecondaryIndexUpdates
```
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 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.
- Class com.amazonaws.services.dynamodbv2.model.UpdateTableResult extends Object implements Serializable
  - Serialized Fields
    - tableDescription
```
TableDescription tableDescription
```
- Class com.amazonaws.services.dynamodbv2.model.WriteRequest extends Object implements Serializable
  - Serialized Fields
    - putRequest
```
PutRequest putRequest
```
      A request to perform a PutItem operation.
    - deleteRequest
```
DeleteRequest deleteRequest
```
      A request to perform a DeleteItem operation.
Package com.amazonaws.services.dynamodbv2.util
- Class com.amazonaws.services.dynamodbv2.util.TableUtils.TableNeverTransitionedToStateException extends AmazonClientException implements Serializable
  
  serialVersionUID:
  
  8920567021104846647L
Package com.amazonaws.services.ec2.model
- Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcPeeringConnectionId
```
String vpcPeeringConnectionId
```
      The ID of the VPC peering connection.
- Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionResult extends Object implements Serializable
  - Serialized Fields
    - vpcPeeringConnection
```
VpcPeeringConnection vpcPeeringConnection
```
      Information about the VPC peering connection.
- Class com.amazonaws.services.ec2.model.AccountAttribute extends Object implements Serializable
  - Serialized Fields
    - attributeName
```
String attributeName
```
      The name of the account attribute.
    - attributeValues
```
com.amazonaws.internal.SdkInternalList<T> attributeValues
```
      One or more values for the account attribute.
- Class com.amazonaws.services.ec2.model.AccountAttributeValue extends Object implements Serializable
  - Serialized Fields
    - attributeValue
```
String attributeValue
```
      The value of the attribute.
- Class com.amazonaws.services.ec2.model.ActiveInstance extends Object implements Serializable
  - Serialized Fields
    - instanceType
```
String instanceType
```
      The instance type.
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - spotInstanceRequestId
```
String spotInstanceRequestId
```
      The ID of the Spot instance request.
- Class com.amazonaws.services.ec2.model.Address extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance that the address is associated with (if any).
    - publicIp
```
String publicIp
```
      The Elastic IP address.
    - allocationId
```
String allocationId
```
      The ID representing the allocation of the address for use with EC2-VPC.
    - associationId
```
String associationId
```
      The ID representing the association of the address with an instance in a VPC.
    - domain
```
String domain
```
      Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC ( vpc).
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - networkInterfaceOwnerId
```
String networkInterfaceOwnerId
```
      The ID of the AWS account that owns the network interface.
    - privateIpAddress
```
String privateIpAddress
```
      The private IP address associated with the Elastic IP address.
- Class com.amazonaws.services.ec2.model.AllocateAddressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - domain
```
String domain
```
      Set to vpc to allocate the address for use with instances in a VPC.
      
      Default: The address is for use with instances in EC2-Classic.
- Class com.amazonaws.services.ec2.model.AllocateAddressResult extends Object implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      The Elastic IP address.
    - domain
```
String domain
```
      Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC ( vpc).
    - allocationId
```
String allocationId
```
      [EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC.
- Class com.amazonaws.services.ec2.model.AllocateHostsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - autoPlacement
```
String autoPlacement
```
      This is enabled by default. This property allows instances to be automatically placed onto available Dedicated hosts, when you are launching instances without specifying a host ID.
      
      Default: Enabled
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    - instanceType
```
String instanceType
```
      Specify the instance type that you want your Dedicated hosts to be configured for. When you specify the instance type, that is the only instance type that you can launch onto that host.
    - quantity
```
Integer quantity
```
      The number of Dedicated hosts you want to allocate to your account with these parameters.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the Dedicated hosts.
- Class com.amazonaws.services.ec2.model.AllocateHostsResult extends Object implements Serializable
  - Serialized Fields
    - hostIds
```
com.amazonaws.internal.SdkInternalList<T> hostIds
```
      The ID of the allocated Dedicated host. This is used when you want to launch an instance onto a specific host.
- Class com.amazonaws.services.ec2.model.AssignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - privateIpAddresses
```
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
```
      One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
      
      If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
    - secondaryPrivateIpAddressCount
```
Integer secondaryPrivateIpAddressCount
```
      The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses.
    - allowReassignment
```
Boolean allowReassignment
```
      Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.
- Class com.amazonaws.services.ec2.model.AssociateAddressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    - publicIp
```
String publicIp
```
      The Elastic IP address. This is required for EC2-Classic.
    - allocationId
```
String allocationId
```
      [EC2-VPC] The allocation ID. This is required for EC2-VPC.
    - networkInterfaceId
```
String networkInterfaceId
```
      [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
    - privateIpAddress
```
String privateIpAddress
```
      [EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.
    - allowReassociation
```
Boolean allowReassociation
```
      [EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.
- Class com.amazonaws.services.ec2.model.AssociateAddressResult extends Object implements Serializable
  - Serialized Fields
    - associationId
```
String associationId
```
      [EC2-VPC] The ID that represents the association of the Elastic IP address with an instance.
- Class com.amazonaws.services.ec2.model.AssociateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - dhcpOptionsId
```
String dhcpOptionsId
```
      The ID of the DHCP options set, or default to associate no DHCP options with the VPC.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.AssociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subnetId
```
String subnetId
```
      The ID of the subnet.
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
- Class com.amazonaws.services.ec2.model.AssociateRouteTableResult extends Object implements Serializable
  - Serialized Fields
    - associationId
```
String associationId
```
      The route table association ID (needed to disassociate the route table).
- Class com.amazonaws.services.ec2.model.AttachClassicLinkVpcRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
    - vpcId
```
String vpcId
```
      The ID of a ClassicLink-enabled VPC.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
- Class com.amazonaws.services.ec2.model.AttachClassicLinkVpcResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.AttachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - internetGatewayId
```
String internetGatewayId
```
      The ID of the Internet gateway.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - deviceIndex
```
Integer deviceIndex
```
      The index of the device for the network interface attachment.
- Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - attachmentId
```
String attachmentId
```
      The ID of the network interface attachment.
- Class com.amazonaws.services.ec2.model.AttachVolumeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - device
```
String device
```
      The device name to expose to the instance (for example, /dev/sdh or xvdh).
- Class com.amazonaws.services.ec2.model.AttachVolumeResult extends Object implements Serializable
  - Serialized Fields
    - attachment
```
VolumeAttachment attachment
```
      Describes volume attachment details.
- Class com.amazonaws.services.ec2.model.AttachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnGatewayId
```
String vpnGatewayId
```
      The ID of the virtual private gateway.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.AttachVpnGatewayResult extends Object implements Serializable
  - Serialized Fields
    - vpcAttachment
```
VpcAttachment vpcAttachment
```
      Information about the attachment.
- Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      The ID of the security group.
    - sourceSecurityGroupName
```
String sourceSecurityGroupName
```
      The name of a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
    - sourceSecurityGroupOwnerId
```
String sourceSecurityGroupOwnerId
```
      The AWS account number for a destination security group. To authorize outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
    - ipProtocol
```
String ipProtocol
```
      The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.
    - fromPort
```
Integer fromPort
```
      The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
    - toPort
```
Integer toPort
```
      The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
    - cidrIp
```
String cidrIp
```
      The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.
    - ipPermissions
```
com.amazonaws.internal.SdkInternalList<T> ipPermissions
```
      A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
- Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      [EC2-Classic, default VPC] The name of the security group.
    - groupId
```
String groupId
```
      The ID of the security group. Required for a nondefault VPC.
    - sourceSecurityGroupName
```
String sourceSecurityGroupName
```
      [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.
    - sourceSecurityGroupOwnerId
```
String sourceSecurityGroupOwnerId
```
      [EC2-Classic] The AWS account number for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.
    - ipProtocol
```
String ipProtocol
```
      The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.
    - fromPort
```
Integer fromPort
```
      The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    - toPort
```
Integer toPort
```
      The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    - cidrIp
```
String cidrIp
```
      The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    - ipPermissions
```
com.amazonaws.internal.SdkInternalList<T> ipPermissions
```
      A set of IP permissions. Can be used to specify multiple rules in a single command.
- Class com.amazonaws.services.ec2.model.AvailabilityZone extends Object implements Serializable
  - Serialized Fields
    - zoneName
```
String zoneName
```
      The name of the Availability Zone.
    - state
```
String state
```
      The state of the Availability Zone.
    - regionName
```
String regionName
```
      The name of the region.
    - messages
```
com.amazonaws.internal.SdkInternalList<T> messages
```
      Any messages about the Availability Zone.
- Class com.amazonaws.services.ec2.model.AvailabilityZoneMessage extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      The message about the Availability Zone.
- Class com.amazonaws.services.ec2.model.AvailableCapacity extends Object implements Serializable
  - Serialized Fields
    - availableInstanceCapacity
```
com.amazonaws.internal.SdkInternalList<T> availableInstanceCapacity
```
      The total number of instances that the Dedicated host supports.
    - availableVCpus
```
Integer availableVCpus
```
      The number of vCPUs available on the Dedicated host.
- Class com.amazonaws.services.ec2.model.BlockDeviceMapping extends Object implements Serializable
  - Serialized Fields
    - virtualName
```
String virtualName
```
      The virtual device name (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.
    - deviceName
```
String deviceName
```
      The device name exposed to the instance (for example, /dev/sdh or xvdh).
    - ebs
```
EbsBlockDevice ebs
```
      Parameters used to automatically set up EBS volumes when the instance is launched.
    - noDevice
```
String noDevice
```
      Suppresses the specified device included in the block device mapping of the AMI.
- Class com.amazonaws.services.ec2.model.BundleInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance to bundle.
      
      Type: String
      
      Default: None
      
      Required: Yes
    - storage
```
Storage storage
```
      The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
- Class com.amazonaws.services.ec2.model.BundleInstanceResult extends Object implements Serializable
  - Serialized Fields
    - bundleTask
```
BundleTask bundleTask
```
      Information about the bundle task.
- Class com.amazonaws.services.ec2.model.BundleTask extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance associated with this bundle task.
    - bundleId
```
String bundleId
```
      The ID of the bundle task.
    - state
```
String state
```
      The state of the task.
    - startTime
```
Date startTime
```
      The time this task started.
    - updateTime
```
Date updateTime
```
      The time of the most recent update for the task.
    - storage
```
Storage storage
```
      The Amazon S3 storage locations.
    - progress
```
String progress
```
      The level of task completion, as a percent (for example, 20%).
    - bundleTaskError
```
BundleTaskError bundleTaskError
```
      If the task fails, a description of the error.
- Class com.amazonaws.services.ec2.model.BundleTaskError extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The error code.
    - message
```
String message
```
      The error message.
- Class com.amazonaws.services.ec2.model.CancelBundleTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - bundleId
```
String bundleId
```
      The ID of the bundle task.
- Class com.amazonaws.services.ec2.model.CancelBundleTaskResult extends Object implements Serializable
  - Serialized Fields
    - bundleTask
```
BundleTask bundleTask
```
      Information about the bundle task.
- Class com.amazonaws.services.ec2.model.CancelConversionTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - conversionTaskId
```
String conversionTaskId
```
      The ID of the conversion task.
    - reasonMessage
```
String reasonMessage
```
      The reason for canceling the conversion task.
- Class com.amazonaws.services.ec2.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportTaskId
```
String exportTaskId
```
      The ID of the export task. This is the ID returned by CreateInstanceExportTask.
- Class com.amazonaws.services.ec2.model.CancelImportTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The ID of the import image or import snapshot task to be canceled.
    - cancelReason
```
String cancelReason
```
      The reason for canceling the task.
- Class com.amazonaws.services.ec2.model.CancelImportTaskResult extends Object implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The ID of the task being canceled.
    - state
```
String state
```
      The current state of the task being canceled.
    - previousState
```
String previousState
```
      The current state of the task being canceled.
- Class com.amazonaws.services.ec2.model.CancelledSpotInstanceRequest extends Object implements Serializable
  - Serialized Fields
    - spotInstanceRequestId
```
String spotInstanceRequestId
```
      The ID of the Spot instance request.
    - state
```
String state
```
      The state of the Spot instance request.
- Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reservedInstancesListingId
```
String reservedInstancesListingId
```
      The ID of the Reserved Instance listing.
- Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesListings
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesListings
```
      The Reserved Instance listing.
- Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsError extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The error code.
    - message
```
String message
```
      The description for the error code.
- Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsErrorItem extends Object implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
    - error
```
CancelSpotFleetRequestsError error
```
      The error.
- Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotFleetRequestIds
```
com.amazonaws.internal.SdkInternalList<T> spotFleetRequestIds
```
      The IDs of the Spot fleet requests.
    - terminateInstances
```
Boolean terminateInstances
```
      Indicates whether to terminate instances for a Spot fleet request if it is canceled successfully.
- Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsResult extends Object implements Serializable
  - Serialized Fields
    - unsuccessfulFleetRequests
```
com.amazonaws.internal.SdkInternalList<T> unsuccessfulFleetRequests
```
      Information about the Spot fleet requests that are not successfully canceled.
    - successfulFleetRequests
```
com.amazonaws.internal.SdkInternalList<T> successfulFleetRequests
```
      Information about the Spot fleet requests that are successfully canceled.
- Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsSuccessItem extends Object implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
    - currentSpotFleetRequestState
```
String currentSpotFleetRequestState
```
      The current state of the Spot fleet request.
    - previousSpotFleetRequestState
```
String previousSpotFleetRequestState
```
      The previous state of the Spot fleet request.
- Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotInstanceRequestIds
```
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequestIds
```
      One or more Spot instance request IDs.
- Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsResult extends Object implements Serializable
  - Serialized Fields
    - cancelledSpotInstanceRequests
```
com.amazonaws.internal.SdkInternalList<T> cancelledSpotInstanceRequests
```
      One or more Spot instance requests.
- Class com.amazonaws.services.ec2.model.ClassicLinkDnsSupport extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - classicLinkDnsSupported
```
Boolean classicLinkDnsSupported
```
      Indicates whether ClassicLink DNS support is enabled for the VPC.
- Class com.amazonaws.services.ec2.model.ClassicLinkInstance extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      A list of security groups.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the instance.
- Class com.amazonaws.services.ec2.model.ClientData extends Object implements Serializable
  - Serialized Fields
    - uploadStart
```
Date uploadStart
```
      The time that the disk upload starts.
    - uploadEnd
```
Date uploadEnd
```
      The time that the disk upload ends.
    - uploadSize
```
Double uploadSize
```
      The size of the uploaded disk image, in GiB.
    - comment
```
String comment
```
      A user-defined comment about the disk upload.
- Class com.amazonaws.services.ec2.model.ConfirmProductInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - productCode
```
String productCode
```
      The product code. This must be a product code that you own.
    - instanceId
```
String instanceId
```
      The ID of the instance.
- Class com.amazonaws.services.ec2.model.ConfirmProductInstanceResult extends Object implements Serializable
  - Serialized Fields
    - ownerId
```
String ownerId
```
      The AWS account ID of the instance owner. This is only present if the product code is attached to the instance.
    - returnValue
```
Boolean returnValue
```
      The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
- Class com.amazonaws.services.ec2.model.ConversionTask extends Object implements Serializable
  - Serialized Fields
    - conversionTaskId
```
String conversionTaskId
```
      The ID of the conversion task.
    - expirationTime
```
String expirationTime
```
      The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.
    - importInstance
```
ImportInstanceTaskDetails importInstance
```
      If the task is for importing an instance, this contains information about the import instance task.
    - importVolume
```
ImportVolumeTaskDetails importVolume
```
      If the task is for importing a volume, this contains information about the import volume task.
    - state
```
String state
```
      The state of the conversion task.
    - statusMessage
```
String statusMessage
```
      The status message related to the conversion task.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the task.
- Class com.amazonaws.services.ec2.model.CopyImageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sourceRegion
```
String sourceRegion
```
      The name of the region that contains the AMI to copy.
    - sourceImageId
```
String sourceImageId
```
      The ID of the AMI to copy.
    - name
```
String name
```
      The name of the new AMI in the destination region.
    - description
```
String description
```
      A description for the new AMI in the destination region.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    - encrypted
```
Boolean encrypted
```
      Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    - kmsKeyId
```
String kmsKeyId
```
      The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the 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.
- Class com.amazonaws.services.ec2.model.CopyImageResult extends Object implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the new AMI.
- Class com.amazonaws.services.ec2.model.CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - sourceRegion
```
String sourceRegion
```
      The ID of the region that contains the snapshot to be copied.
    - sourceSnapshotId
```
String sourceSnapshotId
```
      The ID of the EBS snapshot to copy.
    - description
```
String description
```
      A description for the EBS snapshot.
    - destinationRegion
```
String destinationRegion
```
      The destination region to use in the 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).
    - presignedUrl
```
String presignedUrl
```
      The pre-signed URL that facilitates copying an encrypted snapshot. This parameter is only required when copying an encrypted snapshot with the Amazon EC2 Query API; it is available as an optional parameter in all other cases. The 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.
    - encrypted
```
Boolean encrypted
```
      Specifies whether the destination snapshot should be encrypted. There is no way to create an unencrypted snapshot copy from an encrypted snapshot; however, you can encrypt a copy of an unencrypted snapshot with this flag. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    - kmsKeyId
```
String kmsKeyId
```
      The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when creating the snapshot copy. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the 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.
- Class com.amazonaws.services.ec2.model.CopySnapshotResult extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the new snapshot.
- Class com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of VPN connection that this customer gateway supports ( ipsec.1).
    - publicIp
```
String publicIp
```
      The Internet-routable IP address for the customer gateway's outside interface. The address must be static.
    - bgpAsn
```
Integer bgpAsn
```
      For devices that support BGP, the customer gateway's BGP ASN.
      
      Default: 65000
- Class com.amazonaws.services.ec2.model.CreateCustomerGatewayResult extends Object implements Serializable
  - Serialized Fields
    - customerGateway
```
CustomerGateway customerGateway
```
      Information about the customer gateway.
- Class com.amazonaws.services.ec2.model.CreateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - dhcpConfigurations
```
com.amazonaws.internal.SdkInternalList<T> dhcpConfigurations
```
      A DHCP configuration option.
- Class com.amazonaws.services.ec2.model.CreateDhcpOptionsResult extends Object implements Serializable
  - Serialized Fields
    - dhcpOptions
```
DhcpOptions dhcpOptions
```
      A set of DHCP options.
- Class com.amazonaws.services.ec2.model.CreateFlowLogsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceIds
```
com.amazonaws.internal.SdkInternalList<T> resourceIds
```
      One or more subnet, network interface, or VPC IDs.
    - resourceType
```
String resourceType
```
      The type of resource on which to create the flow log.
    - trafficType
```
String trafficType
```
      The type of traffic to log.
    - logGroupName
```
String logGroupName
```
      The name of the CloudWatch log group.
    - deliverLogsPermissionArn
```
String deliverLogsPermissionArn
```
      The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
- Class com.amazonaws.services.ec2.model.CreateFlowLogsResult extends Object implements Serializable
  - Serialized Fields
    - flowLogIds
```
com.amazonaws.internal.SdkInternalList<T> flowLogIds
```
      The IDs of the flow logs.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
    - unsuccessful
```
com.amazonaws.internal.SdkInternalList<T> unsuccessful
```
      Information about the flow logs that could not be created successfully.
- Class com.amazonaws.services.ec2.model.CreateImageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - name
```
String name
```
      A name for the new image.
      
      Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
    - description
```
String description
```
      A description for the new image.
    - noReboot
```
Boolean noReboot
```
      By default, this parameter is set to 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.
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      Information about one or more block device mappings.
- Class com.amazonaws.services.ec2.model.CreateImageResult extends Object implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the new AMI.
- Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A description for the conversion task or the resource being exported. The maximum length is 255 bytes.
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - targetEnvironment
```
String targetEnvironment
```
      The target virtualization environment.
    - exportToS3Task
```
ExportToS3TaskSpecification exportToS3Task
```
      The format and location for an instance export task.
- Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskResult extends Object implements Serializable
  - Serialized Fields
    - exportTask
```
ExportTask exportTask
```
      Information about the instance export task.
- Class com.amazonaws.services.ec2.model.CreateInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.ec2.model.CreateInternetGatewayResult extends Object implements Serializable
  - Serialized Fields
    - internetGateway
```
InternetGateway internetGateway
```
      Information about the Internet gateway.
- Class com.amazonaws.services.ec2.model.CreateKeyPairRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      A unique name for the key pair.
      
      Constraints: Up to 255 ASCII characters
- Class com.amazonaws.services.ec2.model.CreateKeyPairResult extends Object implements Serializable
  - Serialized Fields
    - keyPair
```
KeyPair keyPair
```
      Describes a key pair.
- Class com.amazonaws.services.ec2.model.CreateNatGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subnetId
```
String subnetId
```
      The subnet in which to create the NAT gateway.
    - allocationId
```
String allocationId
```
      The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
      
      Constraint: Maximum 64 ASCII characters.
- Class com.amazonaws.services.ec2.model.CreateNatGatewayResult extends Object implements Serializable
  - Serialized Fields
    - natGateway
```
NatGateway natGateway
```
      Information about the NAT gateway.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.
- Class com.amazonaws.services.ec2.model.CreateNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkAclId
```
String networkAclId
```
      The ID of the network ACL.
    - ruleNumber
```
Integer ruleNumber
```
      The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.
      
      Constraints: Positive integer from 1 to 32766
    - protocol
```
String protocol
```
      The protocol. A value of -1 means all protocols.
    - ruleAction
```
String ruleAction
```
      Indicates whether to allow or deny the traffic that matches the rule.
    - egress
```
Boolean egress
```
      Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
    - cidrBlock
```
String cidrBlock
```
      The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
    - icmpTypeCode
```
IcmpTypeCode icmpTypeCode
```
      ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.
    - portRange
```
PortRange portRange
```
      TCP or UDP protocols: The range of ports the rule applies to.
- Class com.amazonaws.services.ec2.model.CreateNetworkAclRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.CreateNetworkAclResult extends Object implements Serializable
  - Serialized Fields
    - networkAcl
```
NetworkAcl networkAcl
```
      Information about the network ACL.
- Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subnetId
```
String subnetId
```
      The ID of the subnet to associate with the network interface.
    - description
```
String description
```
      A description for the network interface.
    - privateIpAddress
```
String privateIpAddress
```
      The primary private IP address of the network interface. If you don't specify an IP address, Amazon EC2 selects one for you from the subnet range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      The IDs of one or more security groups.
    - privateIpAddresses
```
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
```
      One or more private IP addresses.
    - secondaryPrivateIpAddressCount
```
Integer secondaryPrivateIpAddressCount
```
      The number of secondary private IP addresses to assign to a network interface. When you specify a number of secondary IP addresses, Amazon EC2 selects these IP addresses within the subnet range. You can't specify this option and specify more than one private IP address using 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.
- Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceResult extends Object implements Serializable
  - Serialized Fields
    - networkInterface
```
NetworkInterface networkInterface
```
      Information about the network interface.
- Class com.amazonaws.services.ec2.model.CreatePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      A name for the placement group.
      
      Constraints: Up to 255 ASCII characters
    - strategy
```
String strategy
```
      The placement strategy.
- Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reservedInstancesId
```
String reservedInstancesId
```
      The ID of the active Reserved Instance.
    - instanceCount
```
Integer instanceCount
```
      The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.
    - priceSchedules
```
com.amazonaws.internal.SdkInternalList<T> priceSchedules
```
      A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.
- Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesListings
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesListings
```
      Information about the Reserved Instance listing.
- Class com.amazonaws.services.ec2.model.CreateRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routeTableId
```
String routeTableId
```
      The ID of the route table for the route.
    - destinationCidrBlock
```
String destinationCidrBlock
```
      The CIDR address block used for the destination match. Routing decisions are based on the most specific match.
    - gatewayId
```
String gatewayId
```
      The ID of an Internet gateway or virtual private gateway attached to your VPC.
    - instanceId
```
String instanceId
```
      The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of a network interface.
    - vpcPeeringConnectionId
```
String vpcPeeringConnectionId
```
      The ID of a VPC peering connection.
    - natGatewayId
```
String natGatewayId
```
      The ID of a NAT gateway.
- Class com.amazonaws.services.ec2.model.CreateRouteResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.CreateRouteTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.CreateRouteTableResult extends Object implements Serializable
  - Serialized Fields
    - routeTable
```
RouteTable routeTable
```
      Information about the route table.
- Class com.amazonaws.services.ec2.model.CreateSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the security group.
      
      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 ._-:/()#,@[]+=;{}!$*
    - description
```
String description
```
      A description for the security group. This is informational only.
      
      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 ._-:/()#,@[]+=;{}!$*
    - vpcId
```
String vpcId
```
      [EC2-VPC] The ID of the VPC. Required for EC2-VPC.
- Class com.amazonaws.services.ec2.model.CreateSecurityGroupResult extends Object implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      The ID of the security group.
- Class com.amazonaws.services.ec2.model.CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the EBS volume.
    - description
```
String description
```
      A description for the snapshot.
- Class com.amazonaws.services.ec2.model.CreateSnapshotResult extends Object implements Serializable
  - Serialized Fields
    - snapshot
```
Snapshot snapshot
```
      Describes a snapshot.
- Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - bucket
```
String bucket
```
      The Amazon S3 bucket in which to store the Spot instance data feed.
    - prefix
```
String prefix
```
      A prefix for the data feed file names.
- Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionResult extends Object implements Serializable
  - Serialized Fields
    - spotDatafeedSubscription
```
SpotDatafeedSubscription spotDatafeedSubscription
```
      The Spot instance data feed subscription.
- Class com.amazonaws.services.ec2.model.CreateSubnetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - cidrBlock
```
String cidrBlock
```
      The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the subnet.
      
      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.
- Class com.amazonaws.services.ec2.model.CreateSubnetResult extends Object implements Serializable
  - Serialized Fields
    - subnet
```
Subnet subnet
```
      Information about the subnet.
- Class com.amazonaws.services.ec2.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resources
```
com.amazonaws.internal.SdkInternalList<T> resources
```
      The IDs of one or more resources to tag. For example, ami-1a2b3c4d.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      One or more tags. The 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.
- Class com.amazonaws.services.ec2.model.CreateVolumePermission extends Object implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.
    - group
```
String group
```
      The specific group that is to be added or removed from a volume's list of create volume permissions.
- Class com.amazonaws.services.ec2.model.CreateVolumePermissionModifications extends Object implements Serializable
  - Serialized Fields
    - add
```
com.amazonaws.internal.SdkInternalList<T> add
```
      Adds a specific AWS account ID or group to a volume's list of create volume permissions.
    - remove
```
com.amazonaws.internal.SdkInternalList<T> remove
```
      Removes a specific AWS account ID or group from a volume's list of create volume permissions.
- Class com.amazonaws.services.ec2.model.CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - size
```
Integer size
```
      The size of the volume, in GiBs.
      
      Constraints: 1-16384 for gp2, 4-16384 for io1, 500-16384 for st1, 500-16384 for sc1, and 1-1024 for standard. 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.
    - snapshotId
```
String snapshotId
```
      The snapshot from which to create the volume.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you.
    - volumeType
```
String volumeType
```
      The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
      
      Default: standard
    - iops
```
Integer iops
```
      Only valid for Provisioned IOPS SSD volumes. The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 30 IOPS/GiB.
      
      Constraint: Range is 100 to 20000 for Provisioned IOPS SSD volumes
    - encrypted
```
Boolean encrypted
```
      Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only 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 vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
    - kmsKeyId
```
String kmsKeyId
```
      The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. The ARN contains the 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.
- Class com.amazonaws.services.ec2.model.CreateVolumeResult extends Object implements Serializable
  - Serialized Fields
    - volume
```
Volume volume
```
      Describes a volume.
- Class com.amazonaws.services.ec2.model.CreateVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC in which the endpoint will be used.
    - serviceName
```
String serviceName
```
      The AWS service name, in the form com.amazonaws.region.service. To get a list of available services, use the DescribeVpcEndpointServices request.
    - policyDocument
```
String policyDocument
```
      A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service.
    - routeTableIds
```
com.amazonaws.internal.SdkInternalList<T> routeTableIds
```
      One or more route table IDs.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
- Class com.amazonaws.services.ec2.model.CreateVpcEndpointResult extends Object implements Serializable
  - Serialized Fields
    - vpcEndpoint
```
VpcEndpoint vpcEndpoint
```
      Information about the endpoint.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request.
- Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the requester VPC.
    - peerVpcId
```
String peerVpcId
```
      The ID of the VPC with which you are creating the VPC peering connection.
    - peerOwnerId
```
String peerOwnerId
```
      The AWS account ID of the owner of the peer VPC.
      
      Default: Your AWS account ID
- Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionResult extends Object implements Serializable
  - Serialized Fields
    - vpcPeeringConnection
```
VpcPeeringConnection vpcPeeringConnection
```
      Information about the VPC peering connection.
- Class com.amazonaws.services.ec2.model.CreateVpcRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - cidrBlock
```
String cidrBlock
```
      The network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.
    - instanceTenancy
```
String instanceTenancy
```
      The supported tenancy options for instances launched into the VPC. A value of 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
- Class com.amazonaws.services.ec2.model.CreateVpcResult extends Object implements Serializable
  - Serialized Fields
    - vpc
```
Vpc vpc
```
      Information about the VPC.
- Class com.amazonaws.services.ec2.model.CreateVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of VPN connection (ipsec.1).
    - customerGatewayId
```
String customerGatewayId
```
      The ID of the customer gateway.
    - vpnGatewayId
```
String vpnGatewayId
```
      The ID of the virtual private gateway.
    - options
```
VpnConnectionOptionsSpecification options
```
      Indicates whether the VPN connection requires static routes. If you are creating a VPN connection for a device that does not support BGP, you must specify true.
      
      Default: false
- Class com.amazonaws.services.ec2.model.CreateVpnConnectionResult extends Object implements Serializable
  - Serialized Fields
    - vpnConnection
```
VpnConnection vpnConnection
```
      Information about the VPN connection.
- Class com.amazonaws.services.ec2.model.CreateVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnConnectionId
```
String vpnConnectionId
```
      The ID of the VPN connection.
    - destinationCidrBlock
```
String destinationCidrBlock
```
      The CIDR block associated with the local subnet of the customer network.
- Class com.amazonaws.services.ec2.model.CreateVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - type
```
String type
```
      The type of VPN connection this virtual private gateway supports.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the virtual private gateway.
- Class com.amazonaws.services.ec2.model.CreateVpnGatewayResult extends Object implements Serializable
  - Serialized Fields
    - vpnGateway
```
VpnGateway vpnGateway
```
      Information about the virtual private gateway.
- Class com.amazonaws.services.ec2.model.CustomerGateway extends Object implements Serializable
  - Serialized Fields
    - customerGatewayId
```
String customerGatewayId
```
      The ID of the customer gateway.
    - state
```
String state
```
      The current state of the customer gateway ( pending | available | deleting | deleted).
    - type
```
String type
```
      The type of VPN connection the customer gateway supports ( ipsec.1).
    - ipAddress
```
String ipAddress
```
      The Internet-routable IP address of the customer gateway's outside interface.
    - bgpAsn
```
String bgpAsn
```
      The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the customer gateway.
- Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - customerGatewayId
```
String customerGatewayId
```
      The ID of the customer gateway.
- Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - dhcpOptionsId
```
String dhcpOptionsId
```
      The ID of the DHCP options set.
- Class com.amazonaws.services.ec2.model.DeleteFlowLogsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flowLogIds
```
com.amazonaws.internal.SdkInternalList<T> flowLogIds
```
      One or more flow log IDs.
- Class com.amazonaws.services.ec2.model.DeleteFlowLogsResult extends Object implements Serializable
  - Serialized Fields
    - unsuccessful
```
com.amazonaws.internal.SdkInternalList<T> unsuccessful
```
      Information about the flow logs that could not be deleted successfully.
- Class com.amazonaws.services.ec2.model.DeleteInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - internetGatewayId
```
String internetGatewayId
```
      The ID of the Internet gateway.
- Class com.amazonaws.services.ec2.model.DeleteKeyPairRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      The name of the key pair.
- Class com.amazonaws.services.ec2.model.DeleteNatGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - natGatewayId
```
String natGatewayId
```
      The ID of the NAT gateway.
- Class com.amazonaws.services.ec2.model.DeleteNatGatewayResult extends Object implements Serializable
  - Serialized Fields
    - natGatewayId
```
String natGatewayId
```
      The ID of the NAT gateway.
- Class com.amazonaws.services.ec2.model.DeleteNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkAclId
```
String networkAclId
```
      The ID of the network ACL.
    - ruleNumber
```
Integer ruleNumber
```
      The rule number of the entry to delete.
    - egress
```
Boolean egress
```
      Indicates whether the rule is an egress rule.
- Class com.amazonaws.services.ec2.model.DeleteNetworkAclRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkAclId
```
String networkAclId
```
      The ID of the network ACL.
- Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
- Class com.amazonaws.services.ec2.model.DeletePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the placement group.
- Class com.amazonaws.services.ec2.model.DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
    - destinationCidrBlock
```
String destinationCidrBlock
```
      The CIDR range for the route. The value you specify must match the CIDR for the route exactly.
- Class com.amazonaws.services.ec2.model.DeleteRouteTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
- Class com.amazonaws.services.ec2.model.DeleteSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      [EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.
    - groupId
```
String groupId
```
      The ID of the security group. Required for a nondefault VPC.
- Class com.amazonaws.services.ec2.model.DeleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the EBS snapshot.
- Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.ec2.model.DeleteSubnetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subnetId
```
String subnetId
```
      The ID of the subnet.
- Class com.amazonaws.services.ec2.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resources
```
com.amazonaws.internal.SdkInternalList<T> resources
```
      The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      One or more tags to delete. If you omit the 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.
- Class com.amazonaws.services.ec2.model.DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the volume.
- Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcEndpointIds
```
com.amazonaws.internal.SdkInternalList<T> vpcEndpointIds
```
      One or more endpoint IDs.
- Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsResult extends Object implements Serializable
  - Serialized Fields
    - unsuccessful
```
com.amazonaws.internal.SdkInternalList<T> unsuccessful
```
      Information about the endpoints that were not successfully deleted.
- Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcPeeringConnectionId
```
String vpcPeeringConnectionId
```
      The ID of the VPC peering connection.
- Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.DeleteVpcRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnConnectionId
```
String vpnConnectionId
```
      The ID of the VPN connection.
- Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnConnectionId
```
String vpnConnectionId
```
      The ID of the VPN connection.
    - destinationCidrBlock
```
String destinationCidrBlock
```
      The CIDR block associated with the local subnet of the customer network.
- Class com.amazonaws.services.ec2.model.DeleteVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnGatewayId
```
String vpnGatewayId
```
      The ID of the virtual private gateway.
- Class com.amazonaws.services.ec2.model.DeregisterImageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI.
- Class com.amazonaws.services.ec2.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attributeNames
```
com.amazonaws.internal.SdkInternalList<T> attributeNames
```
      One or more account attribute names.
- Class com.amazonaws.services.ec2.model.DescribeAccountAttributesResult extends Object implements Serializable
  - Serialized Fields
    - accountAttributes
```
com.amazonaws.internal.SdkInternalList<T> accountAttributes
```
      Information about one or more account attributes.
- Class com.amazonaws.services.ec2.model.DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - publicIps
```
com.amazonaws.internal.SdkInternalList<T> publicIps
```
      [EC2-Classic] One or more Elastic IP addresses.
      
      Default: Describes all your Elastic IP addresses.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters. Filter names and values are case-sensitive.
      
      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.
    - allocationIds
```
com.amazonaws.internal.SdkInternalList<T> allocationIds
```
      [EC2-VPC] One or more allocation IDs.
      
      Default: Describes all your Elastic IP addresses.
- Class com.amazonaws.services.ec2.model.DescribeAddressesResult extends Object implements Serializable
  - Serialized Fields
    - addresses
```
com.amazonaws.internal.SdkInternalList<T> addresses
```
      Information about one or more Elastic IP addresses.
- Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - zoneNames
```
com.amazonaws.internal.SdkInternalList<T> zoneNames
```
      The names of one or more Availability Zones.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
- Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesResult extends Object implements Serializable
  - Serialized Fields
    - availabilityZones
```
com.amazonaws.internal.SdkInternalList<T> availabilityZones
```
      Information about one or more Availability Zones.
- Class com.amazonaws.services.ec2.model.DescribeBundleTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - bundleIds
```
com.amazonaws.internal.SdkInternalList<T> bundleIds
```
      One or more bundle task IDs.
      
      Default: Describes all your bundle tasks.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeBundleTasksResult extends Object implements Serializable
  - Serialized Fields
    - bundleTasks
```
com.amazonaws.internal.SdkInternalList<T> bundleTasks
```
      Information about one or more bundle tasks.
- Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return for the request in a single page. 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. 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.
- Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesResult extends Object implements Serializable
  - Serialized Fields
    - instances
```
com.amazonaws.internal.SdkInternalList<T> instances
```
      Information about one or more linked EC2-Classic instances.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeConversionTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters.
    - conversionTaskIds
```
com.amazonaws.internal.SdkInternalList<T> conversionTaskIds
```
      One or more conversion task IDs.
- Class com.amazonaws.services.ec2.model.DescribeConversionTasksResult extends Object implements Serializable
  - Serialized Fields
    - conversionTasks
```
com.amazonaws.internal.SdkInternalList<T> conversionTasks
```
      Information about the conversion tasks.
- Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - customerGatewayIds
```
com.amazonaws.internal.SdkInternalList<T> customerGatewayIds
```
      One or more customer gateway IDs.
      
      Default: Describes all your customer gateways.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysResult extends Object implements Serializable
  - Serialized Fields
    - customerGateways
```
com.amazonaws.internal.SdkInternalList<T> customerGateways
```
      Information about one or more customer gateways.
- Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - dhcpOptionsIds
```
com.amazonaws.internal.SdkInternalList<T> dhcpOptionsIds
```
      The IDs of one or more DHCP options sets.
      
      Default: Describes all your DHCP options sets.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsResult extends Object implements Serializable
  - Serialized Fields
    - dhcpOptions
```
com.amazonaws.internal.SdkInternalList<T> dhcpOptions
```
      Information about one or more DHCP options sets.
- Class com.amazonaws.services.ec2.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - exportTaskIds
```
com.amazonaws.internal.SdkInternalList<T> exportTaskIds
```
      One or more export task IDs.
- Class com.amazonaws.services.ec2.model.DescribeExportTasksResult extends Object implements Serializable
  - Serialized Fields
    - exportTasks
```
com.amazonaws.internal.SdkInternalList<T> exportTasks
```
      Information about the export tasks.
- Class com.amazonaws.services.ec2.model.DescribeFlowLogsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - flowLogIds
```
com.amazonaws.internal.SdkInternalList<T> flowLogIds
```
      One or more flow log IDs.
    - filter
```
com.amazonaws.internal.SdkInternalList<T> filter
```
      One or more filters.
      
      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)
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return for the request in a single page. The remaining results 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. You cannot specify this parameter and the flow log IDs parameter in the same request.
- Class com.amazonaws.services.ec2.model.DescribeFlowLogsResult extends Object implements Serializable
  - Serialized Fields
    - flowLogs
```
com.amazonaws.internal.SdkInternalList<T> flowLogs
```
      Information about the flow logs.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeHostsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hostIds
```
com.amazonaws.internal.SdkInternalList<T> hostIds
```
      The IDs of the Dedicated hosts. The IDs are used for targeted instance launches.
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned 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.
    - filter
```
com.amazonaws.internal.SdkInternalList<T> filter
```
      One or more filters.
      
      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.
- Class com.amazonaws.services.ec2.model.DescribeHostsResult extends Object implements Serializable
  - Serialized Fields
    - hosts
```
com.amazonaws.internal.SdkInternalList<T> hosts
```
      Information about the Dedicated hosts.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeIdFormatRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resource
```
String resource
```
      The type of resource.
- Class com.amazonaws.services.ec2.model.DescribeIdFormatResult extends Object implements Serializable
  - Serialized Fields
    - statuses
```
com.amazonaws.internal.SdkInternalList<T> statuses
```
      Information about the ID format for the resource.
- Class com.amazonaws.services.ec2.model.DescribeImageAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI.
    - attribute
```
String attribute
```
      The AMI 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.
- Class com.amazonaws.services.ec2.model.DescribeImageAttributeResult extends Object implements Serializable
  - Serialized Fields
    - imageAttribute
```
ImageAttribute imageAttribute
```
      Describes an image attribute.
- Class com.amazonaws.services.ec2.model.DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageIds
```
com.amazonaws.internal.SdkInternalList<T> imageIds
```
      One or more image IDs.
      
      Default: Describes all images available to you.
    - owners
```
com.amazonaws.internal.SdkInternalList<T> owners
```
      Filters the images by the owner. Specify an AWS account ID, 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.
    - executableUsers
```
com.amazonaws.internal.SdkInternalList<T> executableUsers
```
      Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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 | io1 | st1 | sc1 | standard).
      
      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).
- Class com.amazonaws.services.ec2.model.DescribeImagesResult extends Object implements Serializable
  - Serialized Fields
    - images
```
com.amazonaws.internal.SdkInternalList<T> images
```
      Information about one or more images.
- Class com.amazonaws.services.ec2.model.DescribeImportImageTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - importTaskIds
```
com.amazonaws.internal.SdkInternalList<T> importTaskIds
```
      A list of import image task IDs.
    - nextToken
```
String nextToken
```
      A token that indicates the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters.
- Class com.amazonaws.services.ec2.model.DescribeImportImageTasksResult extends Object implements Serializable
  - Serialized Fields
    - importImageTasks
```
com.amazonaws.internal.SdkInternalList<T> importImageTasks
```
      A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
    - nextToken
```
String nextToken
```
      The token to use to get the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeImportSnapshotTasksRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - importTaskIds
```
com.amazonaws.internal.SdkInternalList<T> importTaskIds
```
      A list of import snapshot task IDs.
    - nextToken
```
String nextToken
```
      A token that indicates the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters.
- Class com.amazonaws.services.ec2.model.DescribeImportSnapshotTasksResult extends Object implements Serializable
  - Serialized Fields
    - importSnapshotTasks
```
com.amazonaws.internal.SdkInternalList<T> importSnapshotTasks
```
      A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
    - nextToken
```
String nextToken
```
      The token to use to get the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - attribute
```
String attribute
```
      The instance attribute.
- Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeResult extends Object implements Serializable
  - Serialized Fields
    - instanceAttribute
```
InstanceAttribute instanceAttribute
```
      Describes an instance attribute.
- Class com.amazonaws.services.ec2.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs.
      
      Default: Describes all your instances.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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 or a Scheduled Instance (spot | scheduled).
      
      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.
    - nextToken
```
String nextToken
```
      The token to request the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
- Class com.amazonaws.services.ec2.model.DescribeInstancesResult extends Object implements Serializable
  - Serialized Fields
    - reservations
```
com.amazonaws.internal.SdkInternalList<T> reservations
```
      Zero or more reservations.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs.
      
      Default: Describes all your instances.
      
      Constraints: Maximum 100 explicitly specified instance IDs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
    - includeAllInstances
```
Boolean includeAllInstances
```
      When true, includes the health status for all instances. When false, includes the health status for running instances only.
      
      Default: false
- Class com.amazonaws.services.ec2.model.DescribeInstanceStatusResult extends Object implements Serializable
  - Serialized Fields
    - instanceStatuses
```
com.amazonaws.internal.SdkInternalList<T> instanceStatuses
```
      One or more instance status descriptions.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - internetGatewayIds
```
com.amazonaws.internal.SdkInternalList<T> internetGatewayIds
```
      One or more Internet gateway IDs.
      
      Default: Describes all your Internet gateways.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysResult extends Object implements Serializable
  - Serialized Fields
    - internetGateways
```
com.amazonaws.internal.SdkInternalList<T> internetGateways
```
      Information about one or more Internet gateways.
- Class com.amazonaws.services.ec2.model.DescribeKeyPairsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyNames
```
com.amazonaws.internal.SdkInternalList<T> keyNames
```
      One or more key pair names.
      
      Default: Describes all your key pairs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters.
      
      fingerprint - The fingerprint of the key pair.
      
      key-name - The name of the key pair.
- Class com.amazonaws.services.ec2.model.DescribeKeyPairsResult extends Object implements Serializable
  - Serialized Fields
    - keyPairs
```
com.amazonaws.internal.SdkInternalList<T> keyPairs
```
      Information about one or more key pairs.
- Class com.amazonaws.services.ec2.model.DescribeMovingAddressesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - publicIps
```
com.amazonaws.internal.SdkInternalList<T> publicIps
```
      One or more Elastic IP addresses.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters.
      
      moving-status - The status of the Elastic IP address ( MovingToVpc | RestoringToClassic).
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return for the request in a single page. 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 outside of this range, an error is returned.
      
      Default: If no value is provided, the default is 1000.
- Class com.amazonaws.services.ec2.model.DescribeMovingAddressesResult extends Object implements Serializable
  - Serialized Fields
    - movingAddressStatuses
```
com.amazonaws.internal.SdkInternalList<T> movingAddressStatuses
```
      The status for each Elastic IP address.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeNatGatewaysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - natGatewayIds
```
com.amazonaws.internal.SdkInternalList<T> natGatewayIds
```
      One or more NAT gateway IDs.
    - filter
```
com.amazonaws.internal.SdkInternalList<T> filter
```
      One or more filters.
      
      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.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
      
      Constraint: If the value specified is greater than 1000, we return only 1000 items.
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
- Class com.amazonaws.services.ec2.model.DescribeNatGatewaysResult extends Object implements Serializable
  - Serialized Fields
    - natGateways
```
com.amazonaws.internal.SdkInternalList<T> natGateways
```
      Information about the NAT gateways.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeNetworkAclsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkAclIds
```
com.amazonaws.internal.SdkInternalList<T> networkAclIds
```
      One or more network ACL IDs.
      
      Default: Describes all your network ACLs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeNetworkAclsResult extends Object implements Serializable
  - Serialized Fields
    - networkAcls
```
com.amazonaws.internal.SdkInternalList<T> networkAcls
```
      Information about one or more network ACLs.
- Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - attribute
```
String attribute
```
      The attribute of the network interface.
- Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeResult extends Object implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - description
```
String description
```
      The description of the network interface.
    - sourceDestCheck
```
Boolean sourceDestCheck
```
      Indicates whether source/destination checking is enabled.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      The security groups associated with the network interface.
    - attachment
```
NetworkInterfaceAttachment attachment
```
      The attachment (if any) of the network interface.
- Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkInterfaceIds
```
com.amazonaws.internal.SdkInternalList<T> networkInterfaceIds
```
      One or more network interface IDs.
      
      Default: Describes all your network interfaces.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesResult extends Object implements Serializable
  - Serialized Fields
    - networkInterfaces
```
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
```
      Information about one or more network interfaces.
- Class com.amazonaws.services.ec2.model.DescribePlacementGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupNames
```
com.amazonaws.internal.SdkInternalList<T> groupNames
```
      One or more placement group names.
      
      Default: Describes all your placement groups, or only those otherwise specified.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
- Class com.amazonaws.services.ec2.model.DescribePlacementGroupsResult extends Object implements Serializable
  - Serialized Fields
    - placementGroups
```
com.amazonaws.internal.SdkInternalList<T> placementGroups
```
      One or more placement groups.
- Class com.amazonaws.services.ec2.model.DescribePrefixListsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - prefixListIds
```
com.amazonaws.internal.SdkInternalList<T> prefixListIds
```
      One or more prefix list IDs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters.
      
      prefix-list-id: The ID of a prefix list.
      
      prefix-list-name: The name of a prefix list.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
      
      Constraint: If the value specified is greater than 1000, we return only 1000 items.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a prior call.)
- Class com.amazonaws.services.ec2.model.DescribePrefixListsResult extends Object implements Serializable
  - Serialized Fields
    - prefixLists
```
com.amazonaws.internal.SdkInternalList<T> prefixLists
```
      All available prefix lists.
    - nextToken
```
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.
- Class com.amazonaws.services.ec2.model.DescribeRegionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - regionNames
```
com.amazonaws.internal.SdkInternalList<T> regionNames
```
      The names of one or more regions.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
- Class com.amazonaws.services.ec2.model.DescribeRegionsResult extends Object implements Serializable
  - Serialized Fields
    - regions
```
com.amazonaws.internal.SdkInternalList<T> regions
```
      Information about one or more regions.
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reservedInstancesId
```
String reservedInstancesId
```
      One or more Reserved Instance IDs.
    - reservedInstancesListingId
```
String reservedInstancesListingId
```
      One or more Reserved Instance listing IDs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesListings
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesListings
```
      Information about the Reserved Instance listing.
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reservedInstancesModificationIds
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesModificationIds
```
      IDs for the submitted modification request.
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesModifications
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesModifications
```
      The Reserved Instance modification information.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reservedInstancesOfferingIds
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesOfferingIds
```
      One or more Reserved Instances offering IDs.
    - instanceType
```
String instanceType
```
      The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone in which the Reserved Instance can be used.
    - productDescription
```
String productDescription
```
      The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
    - instanceTenancy
```
String instanceTenancy
```
      The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
      
      Default: default
    - offeringType
```
String offeringType
```
      The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
      
      Default: 100
    - includeMarketplace
```
Boolean includeMarketplace
```
      Include Reserved Instance Marketplace offerings in the response.
    - minDuration
```
Long minDuration
```
      The minimum duration (in seconds) to filter when searching for offerings.
      
      Default: 2592000 (1 month)
    - maxDuration
```
Long maxDuration
```
      The maximum duration (in seconds) to filter when searching for offerings.
      
      Default: 94608000 (3 years)
    - maxInstanceCount
```
Integer maxInstanceCount
```
      The maximum number of instances to filter when searching for offerings.
      
      Default: 20
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesOfferings
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesOfferings
```
      A list of Reserved Instances offerings.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reservedInstancesIds
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesIds
```
      One or more Reserved Instance IDs.
      
      Default: Describes all your Reserved Instances, or only those otherwise specified.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
    - offeringType
```
String offeringType
```
      The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.
- Class com.amazonaws.services.ec2.model.DescribeReservedInstancesResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstances
```
com.amazonaws.internal.SdkInternalList<T> reservedInstances
```
      A list of Reserved Instances.
- Class com.amazonaws.services.ec2.model.DescribeRouteTablesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routeTableIds
```
com.amazonaws.internal.SdkInternalList<T> routeTableIds
```
      One or more route table IDs.
      
      Default: Describes all your route tables.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeRouteTablesResult extends Object implements Serializable
  - Serialized Fields
    - routeTables
```
com.amazonaws.internal.SdkInternalList<T> routeTables
```
      Information about one or more route tables.
- Class com.amazonaws.services.ec2.model.DescribeScheduledInstanceAvailabilityRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - recurrence
```
ScheduledInstanceRecurrenceRequest recurrence
```
      The schedule recurrence.
    - firstSlotStartTimeRange
```
SlotDateTimeRangeRequest firstSlotStartTimeRange
```
      The time period for the first schedule to start.
    - minSlotDurationInHours
```
Integer minSlotDurationInHours
```
      The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
    - maxSlotDurationInHours
```
Integer maxSlotDurationInHours
```
      The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned NextToken value.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
- Class com.amazonaws.services.ec2.model.DescribeScheduledInstanceAvailabilityResult extends Object implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token required to retrieve the next set of results. This value is null when there are no more results to return.
    - scheduledInstanceAvailabilitySet
```
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceAvailabilitySet
```
      Information about the available Scheduled Instances.
- Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - scheduledInstanceIds
```
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceIds
```
      One or more Scheduled Instance IDs.
    - slotStartTimeRange
```
SlotStartTimeRangeRequest slotStartTimeRange
```
      The time period for the first schedule to start.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken value.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
- Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesResult extends Object implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The token required to retrieve the next set of results. This value is null when there are no more results to return.
    - scheduledInstanceSet
```
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceSet
```
      Information about the Scheduled Instances.
- Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupNames
```
com.amazonaws.internal.SdkInternalList<T> groupNames
```
      [EC2-Classic and default VPC only] One or more security group names. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
      
      Default: Describes all your security groups.
    - groupIds
```
com.amazonaws.internal.SdkInternalList<T> groupIds
```
      One or more security group IDs. Required for security groups in a nondefault VPC.
      
      Default: Describes all your security groups.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all 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.
- Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsResult extends Object implements Serializable
  - Serialized Fields
    - securityGroups
```
com.amazonaws.internal.SdkInternalList<T> securityGroups
```
      Information about one or more security groups.
- Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the EBS snapshot.
    - attribute
```
String attribute
```
      The snapshot attribute you would like to view.
- Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeResult extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the EBS snapshot.
    - createVolumePermissions
```
com.amazonaws.internal.SdkInternalList<T> createVolumePermissions
```
      A list of permissions for creating volumes from the snapshot.
    - productCodes
```
com.amazonaws.internal.SdkInternalList<T> productCodes
```
      A list of product codes.
- Class com.amazonaws.services.ec2.model.DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotIds
```
com.amazonaws.internal.SdkInternalList<T> snapshotIds
```
      One or more snapshot IDs.
      
      Default: Describes snapshots for which you have launch permissions.
    - ownerIds
```
com.amazonaws.internal.SdkInternalList<T> ownerIds
```
      Returns the snapshots owned by the specified owner. Multiple owners can be specified.
    - restorableByUserIds
```
com.amazonaws.internal.SdkInternalList<T> restorableByUserIds
```
      One or more AWS accounts IDs that can create volumes from the snapshot.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
    - nextToken
```
String nextToken
```
      The 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.
    - maxResults
```
Integer maxResults
```
      The maximum number of snapshot results returned by 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.
- Class com.amazonaws.services.ec2.model.DescribeSnapshotsResult extends Object implements Serializable
  - Serialized Fields
    - snapshots
```
com.amazonaws.internal.SdkInternalList<T> snapshots
```
      Information about the snapshots.
    - nextToken
```
String nextToken
```
      The 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.
- Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionResult extends Object implements Serializable
  - Serialized Fields
    - spotDatafeedSubscription
```
SpotDatafeedSubscription spotDatafeedSubscription
```
      The Spot instance data feed subscription.
- Class com.amazonaws.services.ec2.model.DescribeSpotFleetInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
- Class com.amazonaws.services.ec2.model.DescribeSpotFleetInstancesResult extends Object implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
    - activeInstances
```
com.amazonaws.internal.SdkInternalList<T> activeInstances
```
      The running instances. Note that this list is refreshed periodically and might be out of date.
    - nextToken
```
String nextToken
```
      The token required to retrieve the next set of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestHistoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
    - eventType
```
String eventType
```
      The type of events to describe. By default, all events are described.
    - startTime
```
Date startTime
```
      The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
    - nextToken
```
String nextToken
```
      The token for the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
- Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestHistoryResult extends Object implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
    - startTime
```
Date startTime
```
      The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
    - lastEvaluatedTime
```
Date lastEvaluatedTime
```
      The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
      
      If nextToken indicates that there are more results, this value is not present.
    - historyRecords
```
com.amazonaws.internal.SdkInternalList<T> historyRecords
```
      Information about the events in the history of the Spot fleet request.
    - nextToken
```
String nextToken
```
      The token required to retrieve the next set of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotFleetRequestIds
```
com.amazonaws.internal.SdkInternalList<T> spotFleetRequestIds
```
      The IDs of the Spot fleet requests.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
- Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestsResult extends Object implements Serializable
  - Serialized Fields
    - spotFleetRequestConfigs
```
com.amazonaws.internal.SdkInternalList<T> spotFleetRequestConfigs
```
      Information about the configuration of your Spot fleet.
    - nextToken
```
String nextToken
```
      The token required to retrieve the next set of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotInstanceRequestIds
```
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequestIds
```
      One or more Spot instance request IDs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
      
      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.
- Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsResult extends Object implements Serializable
  - Serialized Fields
    - spotInstanceRequests
```
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequests
```
      One or more Spot instance requests.
- Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - startTime
```
Date startTime
```
      The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
    - endTime
```
Date endTime
```
      The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
    - instanceTypes
```
com.amazonaws.internal.SdkInternalList<T> instanceTypes
```
      Filters the results by the specified instance types.
    - productDescriptions
```
com.amazonaws.internal.SdkInternalList<T> productDescriptions
```
      Filters the results by the specified basic product descriptions.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
    - availabilityZone
```
String availabilityZone
```
      Filters the results by the specified Availability Zone.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
    - nextToken
```
String nextToken
```
      The token for the next set of results.
- Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryResult extends Object implements Serializable
  - Serialized Fields
    - spotPriceHistory
```
com.amazonaws.internal.SdkInternalList<T> spotPriceHistory
```
      The historical Spot prices.
    - nextToken
```
String nextToken
```
      The token required to retrieve the next set of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subnetIds
```
com.amazonaws.internal.SdkInternalList<T> subnetIds
```
      One or more subnet IDs.
      
      Default: Describes all your subnets.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeSubnetsResult extends Object implements Serializable
  - Serialized Fields
    - subnets
```
com.amazonaws.internal.SdkInternalList<T> subnets
```
      Information about one or more subnets.
- Class com.amazonaws.services.ec2.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
    - maxResults
```
Integer maxResults
```
      The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
    - nextToken
```
String nextToken
```
      The token to retrieve the next page of results.
- Class com.amazonaws.services.ec2.model.DescribeTagsResult extends Object implements Serializable
  - Serialized Fields
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      A list of tags.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return..
- Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the volume.
    - attribute
```
String attribute
```
      The instance attribute.
- Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeResult extends Object implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the volume.
    - autoEnableIO
```
Boolean autoEnableIO
```
      The state of autoEnableIO attribute.
    - productCodes
```
com.amazonaws.internal.SdkInternalList<T> productCodes
```
      A list of product codes.
- Class com.amazonaws.services.ec2.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeIds
```
com.amazonaws.internal.SdkInternalList<T> volumeIds
```
      One or more volume IDs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
    - nextToken
```
String nextToken
```
      The 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.
    - maxResults
```
Integer maxResults
```
      The maximum number of volume results returned by 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.
- Class com.amazonaws.services.ec2.model.DescribeVolumesResult extends Object implements Serializable
  - Serialized Fields
    - volumes
```
com.amazonaws.internal.SdkInternalList<T> volumes
```
      Information about the volumes.
    - nextToken
```
String nextToken
```
      The 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.
- Class com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeIds
```
com.amazonaws.internal.SdkInternalList<T> volumeIds
```
      One or more volume IDs.
      
      Default: Describes all your volumes.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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).
    - nextToken
```
String nextToken
```
      The 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.
    - maxResults
```
Integer maxResults
```
      The maximum number of volume results returned by 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.
- Class com.amazonaws.services.ec2.model.DescribeVolumeStatusResult extends Object implements Serializable
  - Serialized Fields
    - volumeStatuses
```
com.amazonaws.internal.SdkInternalList<T> volumeStatuses
```
      A list of volumes.
    - nextToken
```
String nextToken
```
      The token to use to retrieve the next page of results. This value is null when there are no more results to return.
- Class com.amazonaws.services.ec2.model.DescribeVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - attribute
```
String attribute
```
      The VPC attribute.
- Class com.amazonaws.services.ec2.model.DescribeVpcAttributeResult extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - enableDnsSupport
```
Boolean enableDnsSupport
```
      Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.
    - enableDnsHostnames
```
Boolean enableDnsHostnames
```
      Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.
- Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcIds
```
com.amazonaws.internal.SdkInternalList<T> vpcIds
```
      One or more VPC IDs.
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a prior call.)
- Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportResult extends Object implements Serializable
  - Serialized Fields
    - vpcs
```
com.amazonaws.internal.SdkInternalList<T> vpcs
```
      Information about the ClassicLink DNS support status of the VPCs.
    - nextToken
```
String nextToken
```
      The token to use when requesting the next set of items.
- Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcIds
```
com.amazonaws.internal.SdkInternalList<T> vpcIds
```
      One or more VPCs for which you want to describe the ClassicLink status.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkResult extends Object implements Serializable
  - Serialized Fields
    - vpcs
```
com.amazonaws.internal.SdkInternalList<T> vpcs
```
      The ClassicLink status of one or more VPCs.
- Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServicesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
      
      Constraint: If the value is greater than 1000, we return only 1000 items.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a prior call.)
- Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServicesResult extends Object implements Serializable
  - Serialized Fields
    - serviceNames
```
com.amazonaws.internal.SdkInternalList<T> serviceNames
```
      A list of supported AWS services.
    - nextToken
```
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.
- Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcEndpointIds
```
com.amazonaws.internal.SdkInternalList<T> vpcEndpointIds
```
      One or more endpoint IDs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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)
    - maxResults
```
Integer maxResults
```
      The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
      
      Constraint: If the value is greater than 1000, we return only 1000 items.
    - nextToken
```
String nextToken
```
      The token for the next set of items to return. (You received this token from a prior call.)
- Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsResult extends Object implements Serializable
  - Serialized Fields
    - vpcEndpoints
```
com.amazonaws.internal.SdkInternalList<T> vpcEndpoints
```
      Information about the endpoints.
    - nextToken
```
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.
- Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcPeeringConnectionIds
```
com.amazonaws.internal.SdkInternalList<T> vpcPeeringConnectionIds
```
      One or more VPC peering connection IDs.
      
      Default: Describes all your VPC peering connections.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsResult extends Object implements Serializable
  - Serialized Fields
    - vpcPeeringConnections
```
com.amazonaws.internal.SdkInternalList<T> vpcPeeringConnections
```
      Information about the VPC peering connections.
- Class com.amazonaws.services.ec2.model.DescribeVpcsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcIds
```
com.amazonaws.internal.SdkInternalList<T> vpcIds
```
      One or more VPC IDs.
      
      Default: Describes all your VPCs.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeVpcsResult extends Object implements Serializable
  - Serialized Fields
    - vpcs
```
com.amazonaws.internal.SdkInternalList<T> vpcs
```
      Information about one or more VPCs.
- Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnConnectionIds
```
com.amazonaws.internal.SdkInternalList<T> vpnConnectionIds
```
      One or more VPN connection IDs.
      
      Default: Describes your VPN connections.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsResult extends Object implements Serializable
  - Serialized Fields
    - vpnConnections
```
com.amazonaws.internal.SdkInternalList<T> vpnConnections
```
      Information about one or more VPN connections.
- Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnGatewayIds
```
com.amazonaws.internal.SdkInternalList<T> vpnGatewayIds
```
      One or more virtual private gateway IDs.
      
      Default: Describes all your virtual private gateways.
    - filters
```
com.amazonaws.internal.SdkInternalList<T> filters
```
      One or more 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.
- Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysResult extends Object implements Serializable
  - Serialized Fields
    - vpnGateways
```
com.amazonaws.internal.SdkInternalList<T> vpnGateways
```
      Information about one or more virtual private gateways.
- Class com.amazonaws.services.ec2.model.DetachClassicLinkVpcRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance to unlink from the VPC.
    - vpcId
```
String vpcId
```
      The ID of the VPC to which the instance is linked.
- Class com.amazonaws.services.ec2.model.DetachClassicLinkVpcResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.DetachInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - internetGatewayId
```
String internetGatewayId
```
      The ID of the Internet gateway.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.DetachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - attachmentId
```
String attachmentId
```
      The ID of the attachment.
    - force
```
Boolean force
```
      Specifies whether to force a detachment.
- Class com.amazonaws.services.ec2.model.DetachVolumeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the volume.
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - device
```
String device
```
      The device name.
    - force
```
Boolean force
```
      Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.
- Class com.amazonaws.services.ec2.model.DetachVolumeResult extends Object implements Serializable
  - Serialized Fields
    - attachment
```
VolumeAttachment attachment
```
      Describes volume attachment details.
- Class com.amazonaws.services.ec2.model.DetachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpnGatewayId
```
String vpnGatewayId
```
      The ID of the virtual private gateway.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.DhcpConfiguration extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      The name of a DHCP option.
    - values
```
com.amazonaws.internal.SdkInternalList<T> values
```
      One or more values for the DHCP option.
- Class com.amazonaws.services.ec2.model.DhcpOptions extends Object implements Serializable
  - Serialized Fields
    - dhcpOptionsId
```
String dhcpOptionsId
```
      The ID of the set of DHCP options.
    - dhcpConfigurations
```
com.amazonaws.internal.SdkInternalList<T> dhcpConfigurations
```
      One or more DHCP options in the set.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the DHCP options set.
- Class com.amazonaws.services.ec2.model.DisableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
    - gatewayId
```
String gatewayId
```
      The ID of the virtual private gateway.
- Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.DisassociateAddressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      [EC2-Classic] The Elastic IP address. Required for EC2-Classic.
    - associationId
```
String associationId
```
      [EC2-VPC] The association ID. Required for EC2-VPC.
- Class com.amazonaws.services.ec2.model.DisassociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - associationId
```
String associationId
```
      The association ID representing the current association between the route table and subnet.
- Class com.amazonaws.services.ec2.model.DiskImage extends Object implements Serializable
  - Serialized Fields
    - image
```
DiskImageDetail image
```
      Information about the disk image.
    - description
```
String description
```
      A description of the disk image.
    - volume
```
VolumeDetail volume
```
      Information about the volume.
- Class com.amazonaws.services.ec2.model.DiskImageDescription extends Object implements Serializable
  - Serialized Fields
    - format
```
String format
```
      The disk image format.
    - size
```
Long size
```
      The size of the disk image, in GiB.
    - importManifestUrl
```
String importManifestUrl
```
      A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
      
      For information about the import manifest referenced by this API action, see VM Import Manifest.
    - checksum
```
String checksum
```
      The checksum computed for the disk image.
- Class com.amazonaws.services.ec2.model.DiskImageDetail extends Object implements Serializable
  - Serialized Fields
    - format
```
String format
```
      The disk image format.
    - bytes
```
Long bytes
```
      The size of the disk image, in GiB.
    - importManifestUrl
```
String importManifestUrl
```
      A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
      
      For information about the import manifest referenced by this API action, see VM Import Manifest.
- Class com.amazonaws.services.ec2.model.DiskImageVolumeDescription extends Object implements Serializable
  - Serialized Fields
    - size
```
Long size
```
      The size of the volume, in GiB.
    - id
```
String id
```
      The volume identifier.
- Class com.amazonaws.services.ec2.model.EbsBlockDevice extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - volumeSize
```
Integer volumeSize
```
      The size of the volume, in GiB.
      
      Constraints: 1-16384 for General Purpose SSD (gp2), 4-16384 for Provisioned IOPS SSD (io1), 500-16384 for Throughput Optimized HDD (st1), 500-16384 for Cold HDD ( sc1), and 1-1024 for Magnetic (standard) 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.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the EBS volume is deleted on instance termination.
    - volumeType
```
String volumeType
```
      The volume type: gp2, io1, st1, sc1, or standard.
      
      Default: standard
    - iops
```
Integer iops
```
      The number of I/O operations per second (IOPS) that the volume supports. For io1, this represents the number of IOPS that are provisioned for the volume. For gp2, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information on General Purpose SSD baseline performance, I/O credits, and bursting, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
      
      Constraint: Range is 100-20000 IOPS for io1 volumes and 100-10000 IOPS for gp2 volumes.
      
      Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.
    - encrypted
```
Boolean encrypted
```
      Indicates whether the EBS volume is encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption.
- Class com.amazonaws.services.ec2.model.EbsInstanceBlockDevice extends Object implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the EBS volume.
    - status
```
String status
```
      The attachment state.
    - attachTime
```
Date attachTime
```
      The time stamp when the attachment initiated.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the volume is deleted on instance termination.
- Class com.amazonaws.services.ec2.model.EbsInstanceBlockDeviceSpecification extends Object implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the EBS volume.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the volume is deleted on instance termination.
- Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
    - gatewayId
```
String gatewayId
```
      The ID of the virtual private gateway.
- Class com.amazonaws.services.ec2.model.EnableVolumeIORequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the volume.
- Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
- Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.EventInformation extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance. This information is available only for instanceChange events.
    - eventSubType
```
String eventSubType
```
      The event.
      
      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.
    - eventDescription
```
String eventDescription
```
      The description of the event.
- Class com.amazonaws.services.ec2.model.ExportTask extends Object implements Serializable
  - Serialized Fields
    - exportTaskId
```
String exportTaskId
```
      The ID of the export task.
    - description
```
String description
```
      A description of the resource being exported.
    - state
```
String state
```
      The state of the export task.
    - statusMessage
```
String statusMessage
```
      The status message related to the export task.
    - instanceExportDetails
```
InstanceExportDetails instanceExportDetails
```
      Information about the instance to export.
    - exportToS3Task
```
ExportToS3Task exportToS3Task
```
      Information about the export task.
- Class com.amazonaws.services.ec2.model.ExportToS3Task extends Object implements Serializable
  - Serialized Fields
    - diskImageFormat
```
String diskImageFormat
```
      The format for the exported image.
    - containerFormat
```
String containerFormat
```
      The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
    - s3Bucket
```
String s3Bucket
```
      The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
    - s3Key
```
String s3Key
```
      The encryption key for your S3 bucket.
- Class com.amazonaws.services.ec2.model.ExportToS3TaskSpecification extends Object implements Serializable
  - Serialized Fields
    - diskImageFormat
```
String diskImageFormat
```
      The format for the exported image.
    - containerFormat
```
String containerFormat
```
      The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.
    - s3Bucket
```
String s3Bucket
```
      The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS account [email protected].
    - s3Prefix
```
String s3Prefix
```
      The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
- Class com.amazonaws.services.ec2.model.Filter extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the filter. Filter names are case-sensitive.
    - values
```
com.amazonaws.internal.SdkInternalList<T> values
```
      One or more filter values. Filter values are case-sensitive.
- Class com.amazonaws.services.ec2.model.FlowLog extends Object implements Serializable
  - Serialized Fields
    - creationTime
```
Date creationTime
```
      The date and time the flow log was created.
    - flowLogId
```
String flowLogId
```
      The flow log ID.
    - flowLogStatus
```
String flowLogStatus
```
      The status of the flow log (ACTIVE).
    - resourceId
```
String resourceId
```
      The ID of the resource on which the flow log was created.
    - trafficType
```
String trafficType
```
      The type of traffic captured for the flow log.
    - logGroupName
```
String logGroupName
```
      The name of the flow log group.
    - deliverLogsStatus
```
String deliverLogsStatus
```
      The status of the logs delivery (SUCCESS | FAILED).
    - deliverLogsErrorMessage
```
String deliverLogsErrorMessage
```
      Information about the error that occurred. 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.
    - deliverLogsPermissionArn
```
String deliverLogsPermissionArn
```
      The ARN of the IAM role that posts logs to CloudWatch Logs.
- Class com.amazonaws.services.ec2.model.GetConsoleOutputRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
- Class com.amazonaws.services.ec2.model.GetConsoleOutputResult extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - timestamp
```
Date timestamp
```
      The time the output was last updated.
    - output
```
String output
```
      The console output, Base64 encoded. If using a command line tool, the tools decode the output for you.
- Class com.amazonaws.services.ec2.model.GetPasswordDataRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the Windows instance.
- Class com.amazonaws.services.ec2.model.GetPasswordDataResult extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the Windows instance.
    - timestamp
```
Date timestamp
```
      The time the data was last updated.
    - passwordData
```
String passwordData
```
      The password of the instance.
- Class com.amazonaws.services.ec2.model.GroupIdentifier extends Object implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the security group.
    - groupId
```
String groupId
```
      The ID of the security group.
- Class com.amazonaws.services.ec2.model.HistoryRecord extends Object implements Serializable
  - Serialized Fields
    - timestamp
```
Date timestamp
```
      The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
    - eventType
```
String eventType
```
      The event type.
      
      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.
    - eventInformation
```
EventInformation eventInformation
```
      Information about the event.
- Class com.amazonaws.services.ec2.model.Host extends Object implements Serializable
  - Serialized Fields
    - hostId
```
String hostId
```
      The ID of the Dedicated host.
    - autoPlacement
```
String autoPlacement
```
      Whether auto-placement is on or off.
    - hostReservationId
```
String hostReservationId
```
      The reservation ID of the Dedicated host. This returns a null response if the Dedicated host doesn't have an associated reservation.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    - hostProperties
```
HostProperties hostProperties
```
      The hardware specifications of the Dedicated host.
    - state
```
String state
```
      The Dedicated host's state.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone of the Dedicated host.
    - instances
```
com.amazonaws.internal.SdkInternalList<T> instances
```
      The IDs and instance type that are currently running on the Dedicated host.
    - availableCapacity
```
AvailableCapacity availableCapacity
```
      The number of new instances that can be launched onto the Dedicated host.
- Class com.amazonaws.services.ec2.model.HostInstance extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      the IDs of instances that are running on the Dedicated host.
    - instanceType
```
String instanceType
```
      The instance type size (for example, m3.medium) of the running instance.
- Class com.amazonaws.services.ec2.model.HostProperties extends Object implements Serializable
  - Serialized Fields
    - sockets
```
Integer sockets
```
      The number of sockets on the Dedicated host.
    - cores
```
Integer cores
```
      The number of cores on the Dedicated host.
    - totalVCpus
```
Integer totalVCpus
```
      The number of vCPUs on the Dedicated host.
    - instanceType
```
String instanceType
```
      The instance type size that the Dedicated host supports (for example, m3.medium).
- Class com.amazonaws.services.ec2.model.IamInstanceProfile extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the instance profile.
    - id
```
String id
```
      The ID of the instance profile.
- Class com.amazonaws.services.ec2.model.IamInstanceProfileSpecification extends Object implements Serializable
  - Serialized Fields
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the instance profile.
    - name
```
String name
```
      The name of the instance profile.
- Class com.amazonaws.services.ec2.model.IcmpTypeCode extends Object implements Serializable
  - Serialized Fields
    - type
```
Integer type
```
      The ICMP code. A value of -1 means all codes for the specified ICMP type.
    - code
```
Integer code
```
      The ICMP type. A value of -1 means all types.
- Class com.amazonaws.services.ec2.model.IdFormat extends Object implements Serializable
  - Serialized Fields
    - resource
```
String resource
```
      The type of resource.
    - useLongIds
```
Boolean useLongIds
```
      Indicates whether longer IDs (17-character IDs) are enabled for the resource.
    - deadline
```
Date deadline
```
      The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.
- Class com.amazonaws.services.ec2.model.Image extends Object implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI.
    - imageLocation
```
String imageLocation
```
      The location of the AMI.
    - state
```
String state
```
      The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.
    - ownerId
```
String ownerId
```
      The AWS account ID of the image owner.
    - creationDate
```
String creationDate
```
      The date and time the image was created.
    - publicValue
```
Boolean publicValue
```
      Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
    - productCodes
```
com.amazonaws.internal.SdkInternalList<T> productCodes
```
      Any product codes associated with the AMI.
    - architecture
```
String architecture
```
      The architecture of the image.
    - imageType
```
String imageType
```
      The type of image.
    - kernelId
```
String kernelId
```
      The kernel associated with the image, if any. Only applicable for machine images.
    - ramdiskId
```
String ramdiskId
```
      The RAM disk associated with the image, if any. Only applicable for machine images.
    - platform
```
String platform
```
      The value is Windows for Windows AMIs; otherwise blank.
    - sriovNetSupport
```
String sriovNetSupport
```
      Specifies whether enhanced networking is enabled.
    - stateReason
```
StateReason stateReason
```
      The reason for the state change.
    - imageOwnerAlias
```
String imageOwnerAlias
```
      The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.
    - name
```
String name
```
      The name of the AMI that was provided during image creation.
    - description
```
String description
```
      The description of the AMI that was provided during image creation.
    - rootDeviceType
```
String rootDeviceType
```
      The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.
    - rootDeviceName
```
String rootDeviceName
```
      The device name of the root device (for example, /dev/sda1 or /dev/xvda).
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      Any block device mapping entries.
    - virtualizationType
```
String virtualizationType
```
      The type of virtualization of the AMI.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the image.
    - hypervisor
```
String hypervisor
```
      The hypervisor type of the image.
- Class com.amazonaws.services.ec2.model.ImageAttribute extends Object implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI.
    - launchPermissions
```
com.amazonaws.internal.SdkInternalList<T> launchPermissions
```
      One or more launch permissions.
    - productCodes
```
com.amazonaws.internal.SdkInternalList<T> productCodes
```
      One or more product codes.
    - kernelId
```
String kernelId
```
      The kernel ID.
    - ramdiskId
```
String ramdiskId
```
      The RAM disk ID.
    - description
```
String description
```
      A description for the AMI.
    - sriovNetSupport
```
String sriovNetSupport
```
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      One or more block device mapping entries.
- Class com.amazonaws.services.ec2.model.ImageDiskContainer extends Object implements Serializable
  - Serialized Fields
    - description
```
String description
```
      The description of the disk image.
    - format
```
String format
```
      The format of the disk image being imported.
      
      Valid values: RAW | VHD | VMDK | OVA
    - url
```
String url
```
      The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)
    - userBucket
```
UserBucket userBucket
```
      The S3 bucket for the disk image.
    - deviceName
```
String deviceName
```
      The block device mapping for the disk.
    - snapshotId
```
String snapshotId
```
      The ID of the EBS snapshot to be used for importing the snapshot.
- Class com.amazonaws.services.ec2.model.ImportImageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A description string for the import image task.
    - diskContainers
```
com.amazonaws.internal.SdkInternalList<T> diskContainers
```
      Information about the disk containers.
    - licenseType
```
String licenseType
```
      The license type to be used for the Amazon Machine Image (AMI) after importing.
      
      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
    - hypervisor
```
String hypervisor
```
      The target hypervisor platform.
      
      Valid values: xen
    - architecture
```
String architecture
```
      The architecture of the virtual machine.
      
      Valid values: i386 | x86_64
    - platform
```
String platform
```
      The operating system of the virtual machine.
      
      Valid values: Windows | Linux
    - clientData
```
ClientData clientData
```
      The client-specific data.
    - clientToken
```
String clientToken
```
      The token to enable idempotency for VM import requests.
    - roleName
```
String roleName
```
      The name of the role to use when not using the default role, 'vmimport'.
- Class com.amazonaws.services.ec2.model.ImportImageResult extends Object implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The task ID of the import image task.
    - architecture
```
String architecture
```
      The architecture of the virtual machine.
    - licenseType
```
String licenseType
```
      The license type of the virtual machine.
    - platform
```
String platform
```
      The operating system of the virtual machine.
    - hypervisor
```
String hypervisor
```
      The target hypervisor of the import task.
    - description
```
String description
```
      A description of the import task.
    - snapshotDetails
```
com.amazonaws.internal.SdkInternalList<T> snapshotDetails
```
      Information about the snapshots.
    - imageId
```
String imageId
```
      The ID of the Amazon Machine Image (AMI) created by the import task.
    - progress
```
String progress
```
      The progress of the task.
    - statusMessage
```
String statusMessage
```
      A detailed status message of the import task.
    - status
```
String status
```
      A brief status of the task.
- Class com.amazonaws.services.ec2.model.ImportImageTask extends Object implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The ID of the import image task.
    - architecture
```
String architecture
```
      The architecture of the virtual machine.
      
      Valid values: i386 | x86_64
    - licenseType
```
String licenseType
```
      The license type of the virtual machine.
    - platform
```
String platform
```
      The description string for the import image task.
    - hypervisor
```
String hypervisor
```
      The target hypervisor for the import task.
      
      Valid values: xen
    - description
```
String description
```
      A description of the import task.
    - snapshotDetails
```
com.amazonaws.internal.SdkInternalList<T> snapshotDetails
```
      Information about the snapshots.
    - imageId
```
String imageId
```
      The ID of the Amazon Machine Image (AMI) of the imported virtual machine.
    - progress
```
String progress
```
      The percentage of progress of the import image task.
    - statusMessage
```
String statusMessage
```
      A descriptive status message for the import image task.
    - status
```
String status
```
      A brief status for the import image task.
- Class com.amazonaws.services.ec2.model.ImportInstanceLaunchSpecification extends Object implements Serializable
  - Serialized Fields
    - architecture
```
String architecture
```
      The architecture of the instance.
    - groupNames
```
com.amazonaws.internal.SdkInternalList<T> groupNames
```
      One or more security group names.
    - groupIds
```
com.amazonaws.internal.SdkInternalList<T> groupIds
```
      One or more security group IDs.
    - additionalInfo
```
String additionalInfo
```
      Reserved.
    - userData
```
UserData userData
```
      The Base64-encoded MIME user data to be made available to the instance.
    - instanceType
```
String instanceType
```
      The instance type. For more information about the instance types that you can import, see Before You Get Started in the Amazon Elastic Compute Cloud User Guide.
    - placement
```
Placement placement
```
      The placement information for the instance.
    - monitoring
```
Boolean monitoring
```
      Indicates whether monitoring is enabled.
    - subnetId
```
String subnetId
```
      [EC2-VPC] The ID of the subnet in which to launch the instance.
    - instanceInitiatedShutdownBehavior
```
String instanceInitiatedShutdownBehavior
```
      Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    - privateIpAddress
```
String privateIpAddress
```
      [EC2-VPC] An available IP address from the IP address range of the subnet.
- Class com.amazonaws.services.ec2.model.ImportInstanceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - description
```
String description
```
      A description for the instance being imported.
    - launchSpecification
```
ImportInstanceLaunchSpecification launchSpecification
```
      The launch specification.
    - diskImages
```
com.amazonaws.internal.SdkInternalList<T> diskImages
```
      The disk image.
    - platform
```
String platform
```
      The instance operating system.
- Class com.amazonaws.services.ec2.model.ImportInstanceResult extends Object implements Serializable
  - Serialized Fields
    - conversionTask
```
ConversionTask conversionTask
```
      Information about the conversion task.
- Class com.amazonaws.services.ec2.model.ImportInstanceTaskDetails extends Object implements Serializable
  - Serialized Fields
    - volumes
```
com.amazonaws.internal.SdkInternalList<T> volumes
```
      One or more volumes.
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - platform
```
String platform
```
      The instance operating system.
    - description
```
String description
```
      A description of the task.
- Class com.amazonaws.services.ec2.model.ImportInstanceVolumeDetailItem extends Object implements Serializable
  - Serialized Fields
    - bytesConverted
```
Long bytesConverted
```
      The number of bytes converted so far.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone where the resulting instance will reside.
    - image
```
DiskImageDescription image
```
      The image.
    - volume
```
DiskImageVolumeDescription volume
```
      The volume.
    - status
```
String status
```
      The status of the import of this particular disk image.
    - statusMessage
```
String statusMessage
```
      The status information or errors related to the disk image.
    - description
```
String description
```
      A description of the task.
- Class com.amazonaws.services.ec2.model.ImportKeyPairRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      A unique name for the key pair.
    - publicKeyMaterial
```
String publicKeyMaterial
```
      The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
- Class com.amazonaws.services.ec2.model.ImportKeyPairResult extends Object implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      The key pair name you provided.
    - keyFingerprint
```
String keyFingerprint
```
      The MD5 public key fingerprint as specified in section 4 of RFC 4716.
- Class com.amazonaws.services.ec2.model.ImportSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - description
```
String description
```
      The description string for the import snapshot task.
    - diskContainer
```
SnapshotDiskContainer diskContainer
```
      Information about the disk container.
    - clientData
```
ClientData clientData
```
      The client-specific data.
    - clientToken
```
String clientToken
```
      Token to enable idempotency for VM import requests.
    - roleName
```
String roleName
```
      The name of the role to use when not using the default role, 'vmimport'.
- Class com.amazonaws.services.ec2.model.ImportSnapshotResult extends Object implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The ID of the import snapshot task.
    - snapshotTaskDetail
```
SnapshotTaskDetail snapshotTaskDetail
```
      Information about the import snapshot task.
    - description
```
String description
```
      A description of the import snapshot task.
- Class com.amazonaws.services.ec2.model.ImportSnapshotTask extends Object implements Serializable
  - Serialized Fields
    - importTaskId
```
String importTaskId
```
      The ID of the import snapshot task.
    - snapshotTaskDetail
```
SnapshotTaskDetail snapshotTaskDetail
```
      Describes an import snapshot task.
    - description
```
String description
```
      A description of the import snapshot task.
- Class com.amazonaws.services.ec2.model.ImportVolumeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the resulting EBS volume.
    - image
```
DiskImageDetail image
```
      The disk image.
    - description
```
String description
```
      A description of the volume.
    - volume
```
VolumeDetail volume
```
      The volume size.
- Class com.amazonaws.services.ec2.model.ImportVolumeResult extends Object implements Serializable
  - Serialized Fields
    - conversionTask
```
ConversionTask conversionTask
```
      Information about the conversion task.
- Class com.amazonaws.services.ec2.model.ImportVolumeTaskDetails extends Object implements Serializable
  - Serialized Fields
    - bytesConverted
```
Long bytesConverted
```
      The number of bytes converted so far.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone where the resulting volume will reside.
    - description
```
String description
```
      The description you provided when starting the import volume task.
    - image
```
DiskImageDescription image
```
      The image.
    - volume
```
DiskImageVolumeDescription volume
```
      The volume.
- Class com.amazonaws.services.ec2.model.Instance extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - imageId
```
String imageId
```
      The ID of the AMI used to launch the instance.
    - state
```
InstanceState state
```
      The current state of the instance.
    - privateDnsName
```
String privateDnsName
```
      The private DNS name assigned to the instance. This DNS name can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.
    - publicDnsName
```
String publicDnsName
```
      The public DNS name assigned to the instance. This name is not available until the instance enters the running state. For EC2-VPC, this name is only available if you've enabled DNS hostnames for your VPC.
    - stateTransitionReason
```
String stateTransitionReason
```
      The reason for the most recent state transition. This might be an empty string.
    - keyName
```
String keyName
```
      The name of the key pair, if this instance was launched with an associated key pair.
    - amiLaunchIndex
```
Integer amiLaunchIndex
```
      The AMI launch index, which can be used to find this instance in the launch group.
    - productCodes
```
com.amazonaws.internal.SdkInternalList<T> productCodes
```
      The product codes attached to this instance, if applicable.
    - instanceType
```
String instanceType
```
      The instance type.
    - launchTime
```
Date launchTime
```
      The time the instance was launched.
    - placement
```
Placement placement
```
      The location where the instance launched, if applicable.
    - kernelId
```
String kernelId
```
      The kernel associated with this instance, if applicable.
    - ramdiskId
```
String ramdiskId
```
      The RAM disk associated with this instance, if applicable.
    - platform
```
String platform
```
      The value is Windows for Windows instances; otherwise blank.
    - monitoring
```
Monitoring monitoring
```
      The monitoring information for the instance.
    - subnetId
```
String subnetId
```
      [EC2-VPC] The ID of the subnet in which the instance is running.
    - vpcId
```
String vpcId
```
      [EC2-VPC] The ID of the VPC in which the instance is running.
    - privateIpAddress
```
String privateIpAddress
```
      The private IP address assigned to the instance.
    - publicIpAddress
```
String publicIpAddress
```
      The public IP address assigned to the instance, if applicable.
    - stateReason
```
StateReason stateReason
```
      The reason for the most recent state transition.
    - architecture
```
String architecture
```
      The architecture of the image.
    - rootDeviceType
```
String rootDeviceType
```
      The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
    - rootDeviceName
```
String rootDeviceName
```
      The root device name (for example, /dev/sda1 or /dev/xvda).
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      Any block device mapping entries for the instance.
    - virtualizationType
```
String virtualizationType
```
      The virtualization type of the instance.
    - instanceLifecycle
```
String instanceLifecycle
```
      Indicates whether this is a Spot instance or a Scheduled Instance.
    - spotInstanceRequestId
```
String spotInstanceRequestId
```
      If the request is a Spot instance request, the ID of the request.
    - clientToken
```
String clientToken
```
      The idempotency token you provided when you launched the instance, if applicable.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the instance.
    - securityGroups
```
com.amazonaws.internal.SdkInternalList<T> securityGroups
```
      One or more security groups for the instance.
    - sourceDestCheck
```
Boolean sourceDestCheck
```
      Specifies whether to enable an instance launched in a VPC to perform NAT. This controls whether source/destination checking is enabled on the instance. A value of 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.
    - hypervisor
```
String hypervisor
```
      The hypervisor type of the instance.
    - networkInterfaces
```
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
```
      [EC2-VPC] One or more network interfaces for the instance.
    - iamInstanceProfile
```
IamInstanceProfile iamInstanceProfile
```
      The IAM instance profile associated with the instance, if applicable.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
    - sriovNetSupport
```
String sriovNetSupport
```
      Specifies whether enhanced networking is enabled.
- Class com.amazonaws.services.ec2.model.InstanceAttribute extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - instanceType
```
String instanceType
```
      The instance type.
    - kernelId
```
String kernelId
```
      The kernel ID.
    - ramdiskId
```
String ramdiskId
```
      The RAM disk ID.
    - userData
```
String userData
```
      The Base64-encoded MIME user data.
    - disableApiTermination
```
Boolean disableApiTermination
```
      If the value is true, you can't terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.
    - instanceInitiatedShutdownBehavior
```
String instanceInitiatedShutdownBehavior
```
      Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    - rootDeviceName
```
String rootDeviceName
```
      The name of the root device (for example, /dev/sda1 or /dev/xvda).
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      The block device mapping of the instance.
    - productCodes
```
com.amazonaws.internal.SdkInternalList<T> productCodes
```
      A list of product codes.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Indicates whether the instance is optimized for EBS I/O.
    - sriovNetSupport
```
String sriovNetSupport
```
    - sourceDestCheck
```
Boolean sourceDestCheck
```
      Indicates whether source/destination checking is enabled. A value of true means checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      The security groups associated with the instance.
- Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping extends Object implements Serializable
  - Serialized Fields
    - deviceName
```
String deviceName
```
      The device name exposed to the instance (for example, /dev/sdh or xvdh).
    - ebs
```
EbsInstanceBlockDevice ebs
```
      Parameters used to automatically set up EBS volumes when the instance is launched.
- Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMappingSpecification extends Object implements Serializable
  - Serialized Fields
    - deviceName
```
String deviceName
```
      The device name exposed to the instance (for example, /dev/sdh or xvdh).
    - ebs
```
EbsInstanceBlockDeviceSpecification ebs
```
      Parameters used to automatically set up EBS volumes when the instance is launched.
    - virtualName
```
String virtualName
```
      The virtual device name.
    - noDevice
```
String noDevice
```
      suppress the specified device included in the block device mapping.
- Class com.amazonaws.services.ec2.model.InstanceCapacity extends Object implements Serializable
  - Serialized Fields
    - instanceType
```
String instanceType
```
      The instance type size supported by the Dedicated host.
    - availableCapacity
```
Integer availableCapacity
```
      The number of instances that can still be launched onto the Dedicated host.
    - totalCapacity
```
Integer totalCapacity
```
      The total number of instances that can be launched onto the Dedicated host.
- Class com.amazonaws.services.ec2.model.InstanceCount extends Object implements Serializable
  - Serialized Fields
    - state
```
String state
```
      The states of the listed Reserved Instances.
    - instanceCount
```
Integer instanceCount
```
      The number of listed Reserved Instances in the state specified by the state.
- Class com.amazonaws.services.ec2.model.InstanceExportDetails extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the resource being exported.
    - targetEnvironment
```
String targetEnvironment
```
      The target virtualization environment.
- Class com.amazonaws.services.ec2.model.InstanceMonitoring extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - monitoring
```
Monitoring monitoring
```
      The monitoring information.
- Class com.amazonaws.services.ec2.model.InstanceNetworkInterface extends Object implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - subnetId
```
String subnetId
```
      The ID of the subnet.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - description
```
String description
```
      The description.
    - ownerId
```
String ownerId
```
      The ID of the AWS account that created the network interface.
    - status
```
String status
```
      The status of the network interface.
    - macAddress
```
String macAddress
```
      The MAC address.
    - privateIpAddress
```
String privateIpAddress
```
      The IP address of the network interface within the subnet.
    - privateDnsName
```
String privateDnsName
```
      The private DNS name.
    - sourceDestCheck
```
Boolean sourceDestCheck
```
      Indicates whether to validate network traffic to or from this network interface.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      One or more security groups.
    - attachment
```
InstanceNetworkInterfaceAttachment attachment
```
      The network interface attachment.
    - association
```
InstanceNetworkInterfaceAssociation association
```
      The association information for an Elastic IP associated with the network interface.
    - privateIpAddresses
```
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
```
      The private IP addresses associated with the network interface.
- Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAssociation extends Object implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      The public IP address or Elastic IP address bound to the network interface.
    - publicDnsName
```
String publicDnsName
```
      The public DNS name.
    - ipOwnerId
```
String ipOwnerId
```
      The ID of the owner of the Elastic IP address.
- Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAttachment extends Object implements Serializable
  - Serialized Fields
    - attachmentId
```
String attachmentId
```
      The ID of the network interface attachment.
    - deviceIndex
```
Integer deviceIndex
```
      The index of the device on the instance for the network interface attachment.
    - status
```
String status
```
      The attachment state.
    - attachTime
```
Date attachTime
```
      The time stamp when the attachment initiated.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the network interface is deleted when the instance is terminated.
- Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceSpecification extends Object implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - deviceIndex
```
Integer deviceIndex
```
      The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
    - subnetId
```
String subnetId
```
      The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.
    - description
```
String description
```
      The description of the network interface. Applies only if creating a network interface when launching an instance.
    - privateIpAddress
```
String privateIpAddress
```
      The private IP address of the network interface. Applies only if creating a network interface when launching an instance.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      If set to 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.
    - privateIpAddresses
```
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
```
      One or more private IP addresses to assign to the network interface. Only one private IP address can be designated as primary.
    - secondaryPrivateIpAddressCount
```
Integer secondaryPrivateIpAddressCount
```
      The number of secondary private IP addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option.
    - associatePublicIpAddress
```
Boolean associatePublicIpAddress
```
      Indicates whether to assign a public IP address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.
- Class com.amazonaws.services.ec2.model.InstancePrivateIpAddress extends Object implements Serializable
  - Serialized Fields
    - privateIpAddress
```
String privateIpAddress
```
      The private IP address of the network interface.
    - privateDnsName
```
String privateDnsName
```
      The private DNS name.
    - primary
```
Boolean primary
```
      Indicates whether this IP address is the primary private IP address of the network interface.
    - association
```
InstanceNetworkInterfaceAssociation association
```
      The association information for an Elastic IP address for the network interface.
- Class com.amazonaws.services.ec2.model.InstanceState extends Object implements Serializable
  - Serialized Fields
    - code
```
Integer code
```
      The low byte represents the state. The high byte is an opaque internal value and should be ignored.
      
      0 : pending
      
      16 : running
      
      32 : shutting-down
      
      48 : terminated
      
      64 : stopping
      
      80 : stopped
    - name
```
String name
```
      The current state of the instance.
- Class com.amazonaws.services.ec2.model.InstanceStateChange extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - currentState
```
InstanceState currentState
```
      The current state of the instance.
    - previousState
```
InstanceState previousState
```
      The previous state of the instance.
- Class com.amazonaws.services.ec2.model.InstanceStatus extends Object implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone of the instance.
    - events
```
com.amazonaws.internal.SdkInternalList<T> events
```
      Any scheduled events associated with the instance.
    - instanceState
```
InstanceState instanceState
```
      The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.
    - systemStatus
```
InstanceStatusSummary systemStatus
```
      Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.
    - instanceStatus
```
InstanceStatusSummary instanceStatus
```
      Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.
- Class com.amazonaws.services.ec2.model.InstanceStatusDetails extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The type of instance status.
    - status
```
String status
```
      The status.
    - impairedSince
```
Date impairedSince
```
      The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.
- Class com.amazonaws.services.ec2.model.InstanceStatusEvent extends Object implements Serializable
  - Serialized Fields
    - code
```
String code
```
      The event code.
    - description
```
String description
```
      A description of the event.
      
      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].
    - notBefore
```
Date notBefore
```
      The earliest scheduled start time for the event.
    - notAfter
```
Date notAfter
```
      The latest scheduled end time for the event.
- Class com.amazonaws.services.ec2.model.InstanceStatusSummary extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The status.
    - details
```
com.amazonaws.internal.SdkInternalList<T> details
```
      The system instance health or application instance health.
- Class com.amazonaws.services.ec2.model.InternetGateway extends Object implements Serializable
  - Serialized Fields
    - internetGatewayId
```
String internetGatewayId
```
      The ID of the Internet gateway.
    - attachments
```
com.amazonaws.internal.SdkInternalList<T> attachments
```
      Any VPCs attached to the Internet gateway.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the Internet gateway.
- Class com.amazonaws.services.ec2.model.InternetGatewayAttachment extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - state
```
String state
```
      The current state of the attachment.
- Class com.amazonaws.services.ec2.model.IpPermission extends Object implements Serializable
  - Serialized Fields
    - ipProtocol
```
String ipProtocol
```
      The IP protocol name (for 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.
    - fromPort
```
Integer fromPort
```
      The start of port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.
    - toPort
```
Integer toPort
```
      The end of port range for the TCP and UDP protocols, or an ICMP code. A value of -1 indicates all ICMP codes for the specified ICMP type.
    - userIdGroupPairs
```
com.amazonaws.internal.SdkInternalList<T> userIdGroupPairs
```
      One or more security group and AWS account ID pairs.
    - ipRanges
```
com.amazonaws.internal.SdkInternalList<T> ipRanges
```
      One or more IP ranges.
    - prefixListIds
```
com.amazonaws.internal.SdkInternalList<T> prefixListIds
```
      (Valid for AuthorizeSecurityGroupEgress, RevokeSecurityGroupEgress and DescribeSecurityGroups only) One or more prefix list IDs for an AWS service. In an AuthorizeSecurityGroupEgress request, this is the AWS service that you want to access through a VPC endpoint from instances associated with the security group.
- Class com.amazonaws.services.ec2.model.KeyPair extends Object implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      The name of the key pair.
    - keyFingerprint
```
String keyFingerprint
```
      The SHA-1 digest of the DER encoded private key.
    - keyMaterial
```
String keyMaterial
```
      An unencrypted PEM encoded RSA private key.
- Class com.amazonaws.services.ec2.model.KeyPairInfo extends Object implements Serializable
  - Serialized Fields
    - keyName
```
String keyName
```
      The name of the key pair.
    - keyFingerprint
```
String keyFingerprint
```
      If you used CreateKeyPair to create the key pair, this is the SHA-1 digest of the DER encoded private key. If you used ImportKeyPair to provide AWS the public key, this is the MD5 public key fingerprint as specified in section 4 of RFC4716.
- Class com.amazonaws.services.ec2.model.LaunchPermission extends Object implements Serializable
  - Serialized Fields
    - userId
```
String userId
```
      The AWS account ID.
    - group
```
String group
```
      The name of the group.
- Class com.amazonaws.services.ec2.model.LaunchPermissionModifications extends Object implements Serializable
  - Serialized Fields
    - add
```
com.amazonaws.internal.SdkInternalList<T> add
```
      The AWS account ID to add to the list of launch permissions for the AMI.
    - remove
```
com.amazonaws.internal.SdkInternalList<T> remove
```
      The AWS account ID to remove from the list of launch permissions for the AMI.
- Class com.amazonaws.services.ec2.model.LaunchSpecification extends Object implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI.
    - keyName
```
String keyName
```
      The name of the key pair.
    - userData
```
String userData
```
      The Base64-encoded MIME user data to make available to the instances.
    - addressingType
```
String addressingType
```
      Deprecated.
    - instanceType
```
String instanceType
```
      The instance type.
    - placement
```
SpotPlacement placement
```
      The placement information for the instance.
    - kernelId
```
String kernelId
```
      The ID of the kernel.
    - ramdiskId
```
String ramdiskId
```
      The ID of the RAM disk.
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      One or more block device mapping entries.
      
      Although you can specify encrypted EBS volumes in this block device mapping for your Spot Instances, these volumes are not encrypted.
    - subnetId
```
String subnetId
```
      The ID of the subnet in which to launch the instance.
    - networkInterfaces
```
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
```
      One or more network interfaces.
    - iamInstanceProfile
```
IamInstanceProfileSpecification iamInstanceProfile
```
      The IAM instance profile.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
      
      Default: false
    - allSecurityGroups
```
com.amazonaws.internal.SdkInternalList<T> allSecurityGroups
```
      One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups.
    - monitoringEnabled
```
Boolean monitoringEnabled
```
    - securityGroups
```
com.amazonaws.internal.SdkInternalList<T> securityGroups
```
      One or more security group names.
- Class com.amazonaws.services.ec2.model.ModifyHostsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hostIds
```
com.amazonaws.internal.SdkInternalList<T> hostIds
```
      The host IDs of the Dedicated hosts you want to modify.
    - autoPlacement
```
String autoPlacement
```
      Specify whether to enable or disable auto-placement.
- Class com.amazonaws.services.ec2.model.ModifyHostsResult extends Object implements Serializable
  - Serialized Fields
    - successful
```
com.amazonaws.internal.SdkInternalList<T> successful
```
      The IDs of the Dedicated hosts that were successfully modified.
    - unsuccessful
```
com.amazonaws.internal.SdkInternalList<T> unsuccessful
```
      The IDs of the Dedicated hosts that could not be modified. Check whether the setting you requested can be used.
- Class com.amazonaws.services.ec2.model.ModifyIdFormatRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resource
```
String resource
```
      The type of resource.
    - useLongIds
```
Boolean useLongIds
```
      Indicate whether the resource should use longer IDs (17-character IDs).
- Class com.amazonaws.services.ec2.model.ModifyImageAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI.
    - attribute
```
String attribute
```
      The name of the attribute to modify.
    - operationType
```
String operationType
```
      The operation type.
    - userIds
```
com.amazonaws.internal.SdkInternalList<T> userIds
```
      One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.
    - userGroups
```
com.amazonaws.internal.SdkInternalList<T> userGroups
```
      One or more user groups. This is only valid when modifying the launchPermission attribute.
    - productCodes
```
com.amazonaws.internal.SdkInternalList<T> productCodes
```
      One or more product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.
    - value
```
String value
```
      The value of the attribute being modified. This is only valid when modifying the description attribute.
    - launchPermission
```
LaunchPermissionModifications launchPermission
```
      A launch permission modification.
    - description
```
String description
```
      A description for the AMI.
- Class com.amazonaws.services.ec2.model.ModifyInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - attribute
```
String attribute
```
      The name of the attribute.
    - value
```
String value
```
      A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      Modifies the 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.
    - sourceDestCheck
```
Boolean sourceDestCheck
```
      Specifies whether source/destination checking is enabled. A value of true means that checking is enabled, and false means checking is disabled. This value must be false for a NAT instance to perform NAT.
    - disableApiTermination
```
Boolean disableApiTermination
```
      If the value is 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.
    - instanceType
```
String instanceType
```
      Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.
    - kernel
```
String kernel
```
      Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
    - ramdisk
```
String ramdisk
```
      Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
    - userData
```
String userData
```
      Changes the instance's user data to the specified base64-encoded value. For command line tools, base64 encoding is performed for you.
    - instanceInitiatedShutdownBehavior
```
String instanceInitiatedShutdownBehavior
```
      Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      [EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Specifies whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
    - sriovNetSupport
```
String sriovNetSupport
```
      Set to 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.
- Class com.amazonaws.services.ec2.model.ModifyInstancePlacementRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance that you are modifying.
    - tenancy
```
String tenancy
```
      The tenancy of the instance that you are modifying.
    - affinity
```
String affinity
```
      The new affinity setting for the instance.
    - hostId
```
String hostId
```
      The ID of the Dedicated host that the instance will have affinity with.
- Class com.amazonaws.services.ec2.model.ModifyInstancePlacementResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Is true if the request succeeds, and an error otherwise.
- Class com.amazonaws.services.ec2.model.ModifyNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - description
```
String description
```
      A description for the network interface.
    - sourceDestCheck
```
Boolean sourceDestCheck
```
      Indicates whether source/destination checking is enabled. A value of 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.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.
    - attachment
```
NetworkInterfaceAttachmentChanges attachment
```
      Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.
- Class com.amazonaws.services.ec2.model.ModifyReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
    - reservedInstancesIds
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesIds
```
      The IDs of the Reserved Instances to modify.
    - targetConfigurations
```
com.amazonaws.internal.SdkInternalList<T> targetConfigurations
```
      The configuration settings for the Reserved Instances to modify.
- Class com.amazonaws.services.ec2.model.ModifyReservedInstancesResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesModificationId
```
String reservedInstancesModificationId
```
      The ID for the modification.
- Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - attribute
```
String attribute
```
      The snapshot attribute to modify.
      
      Only volume creation permissions may be modified at the customer level.
    - operationType
```
String operationType
```
      The type of operation to perform to the attribute.
    - userIds
```
com.amazonaws.internal.SdkInternalList<T> userIds
```
      The account ID to modify for the snapshot.
    - groupNames
```
com.amazonaws.internal.SdkInternalList<T> groupNames
```
      The group to modify for the snapshot.
    - createVolumePermission
```
CreateVolumePermissionModifications createVolumePermission
```
      A JSON representation of the snapshot attribute modification.
- Class com.amazonaws.services.ec2.model.ModifySpotFleetRequestRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
    - targetCapacity
```
Integer targetCapacity
```
      The size of the fleet.
    - excessCapacityTerminationPolicy
```
String excessCapacityTerminationPolicy
```
      Indicates whether running Spot instances should be terminated if the target capacity of the Spot fleet request is decreased below the current size of the Spot fleet.
- Class com.amazonaws.services.ec2.model.ModifySpotFleetRequestResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Is true if the request succeeds, and an error otherwise.
- Class com.amazonaws.services.ec2.model.ModifySubnetAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - subnetId
```
String subnetId
```
      The ID of the subnet.
    - mapPublicIpOnLaunch
```
Boolean mapPublicIpOnLaunch
```
      Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.
- Class com.amazonaws.services.ec2.model.ModifyVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - volumeId
```
String volumeId
```
      The ID of the volume.
    - autoEnableIO
```
Boolean autoEnableIO
```
      Indicates whether the volume should be auto-enabled for I/O operations.
- Class com.amazonaws.services.ec2.model.ModifyVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - enableDnsSupport
```
Boolean enableDnsSupport
```
      Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" will succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
      
      You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
    - enableDnsHostnames
```
Boolean enableDnsHostnames
```
      Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
      
      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.
- Class com.amazonaws.services.ec2.model.ModifyVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcEndpointId
```
String vpcEndpointId
```
      The ID of the endpoint.
    - resetPolicy
```
Boolean resetPolicy
```
      Specify true to reset the policy document to the default policy. The default policy allows access to the service.
    - policyDocument
```
String policyDocument
```
      A policy document to attach to the endpoint. The policy must be in valid JSON format.
    - addRouteTableIds
```
com.amazonaws.internal.SdkInternalList<T> addRouteTableIds
```
      One or more route tables IDs to associate with the endpoint.
    - removeRouteTableIds
```
com.amazonaws.internal.SdkInternalList<T> removeRouteTableIds
```
      One or more route table IDs to disassociate from the endpoint.
- Class com.amazonaws.services.ec2.model.ModifyVpcEndpointResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.Monitoring extends Object implements Serializable
  - Serialized Fields
    - state
```
String state
```
      Indicates whether monitoring is enabled for the instance.
- Class com.amazonaws.services.ec2.model.MonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs.
- Class com.amazonaws.services.ec2.model.MonitorInstancesResult extends Object implements Serializable
  - Serialized Fields
    - instanceMonitorings
```
com.amazonaws.internal.SdkInternalList<T> instanceMonitorings
```
      Monitoring information for one or more instances.
- Class com.amazonaws.services.ec2.model.MoveAddressToVpcRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      The Elastic IP address.
- Class com.amazonaws.services.ec2.model.MoveAddressToVpcResult extends Object implements Serializable
  - Serialized Fields
    - allocationId
```
String allocationId
```
      The allocation ID for the Elastic IP address.
    - status
```
String status
```
      The status of the move of the IP address.
- Class com.amazonaws.services.ec2.model.MovingAddressStatus extends Object implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      The Elastic IP address.
    - moveStatus
```
String moveStatus
```
      The status of the Elastic IP address that's being moved to the EC2-VPC platform, or restored to the EC2-Classic platform.
- Class com.amazonaws.services.ec2.model.NatGateway extends Object implements Serializable
  - Serialized Fields
    - vpcId
```
String vpcId
```
      The ID of the VPC in which the NAT gateway is located.
    - subnetId
```
String subnetId
```
      The ID of the subnet in which the NAT gateway is located.
    - natGatewayId
```
String natGatewayId
```
      The ID of the NAT gateway.
    - createTime
```
Date createTime
```
      The date and time the NAT gateway was created.
    - deleteTime
```
Date deleteTime
```
      The date and time the NAT gateway was deleted, if applicable.
    - natGatewayAddresses
```
com.amazonaws.internal.SdkInternalList<T> natGatewayAddresses
```
      Information about the IP addresses and network interface associated with the NAT gateway.
    - state
```
String state
```
      The state of the NAT gateway.
    - failureCode
```
String failureCode
```
      If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)
    - failureMessage
```
String failureMessage
```
      If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
      
      For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
      
      For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
      
      For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
      
      For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
      
      For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
      
      For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
- Class com.amazonaws.services.ec2.model.NatGatewayAddress extends Object implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      The Elastic IP address associated with the NAT gateway.
    - allocationId
```
String allocationId
```
      The allocation ID of the Elastic IP address that's associated with the NAT gateway.
    - privateIp
```
String privateIp
```
      The private IP address associated with the Elastic IP address.
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface associated with the NAT gateway.
- Class com.amazonaws.services.ec2.model.NetworkAcl extends Object implements Serializable
  - Serialized Fields
    - networkAclId
```
String networkAclId
```
      The ID of the network ACL.
    - vpcId
```
String vpcId
```
      The ID of the VPC for the network ACL.
    - isDefault
```
Boolean isDefault
```
      Indicates whether this is the default network ACL for the VPC.
    - entries
```
com.amazonaws.internal.SdkInternalList<T> entries
```
      One or more entries (rules) in the network ACL.
    - associations
```
com.amazonaws.internal.SdkInternalList<T> associations
```
      Any associations between the network ACL and one or more subnets
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the network ACL.
- Class com.amazonaws.services.ec2.model.NetworkAclAssociation extends Object implements Serializable
  - Serialized Fields
    - networkAclAssociationId
```
String networkAclAssociationId
```
      The ID of the association between a network ACL and a subnet.
    - networkAclId
```
String networkAclId
```
      The ID of the network ACL.
    - subnetId
```
String subnetId
```
      The ID of the subnet.
- Class com.amazonaws.services.ec2.model.NetworkAclEntry extends Object implements Serializable
  - Serialized Fields
    - ruleNumber
```
Integer ruleNumber
```
      The rule number for the entry. ACL entries are processed in ascending order by rule number.
    - protocol
```
String protocol
```
      The protocol. A value of -1 means all protocols.
    - ruleAction
```
String ruleAction
```
      Indicates whether to allow or deny the traffic that matches the rule.
    - egress
```
Boolean egress
```
      Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).
    - cidrBlock
```
String cidrBlock
```
      The network range to allow or deny, in CIDR notation.
    - icmpTypeCode
```
IcmpTypeCode icmpTypeCode
```
      ICMP protocol: The ICMP type and code.
    - portRange
```
PortRange portRange
```
      TCP or UDP protocols: The range of ports the rule applies to.
- Class com.amazonaws.services.ec2.model.NetworkInterface extends Object implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - subnetId
```
String subnetId
```
      The ID of the subnet.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone.
    - description
```
String description
```
      A description.
    - ownerId
```
String ownerId
```
      The AWS account ID of the owner of the network interface.
    - requesterId
```
String requesterId
```
      The ID of the entity that launched the instance on your behalf (for example, AWS Management Console or Auto Scaling).
    - requesterManaged
```
Boolean requesterManaged
```
      Indicates whether the network interface is being managed by AWS.
    - status
```
String status
```
      The status of the network interface.
    - macAddress
```
String macAddress
```
      The MAC address.
    - privateIpAddress
```
String privateIpAddress
```
      The IP address of the network interface within the subnet.
    - privateDnsName
```
String privateDnsName
```
      The private DNS name.
    - sourceDestCheck
```
Boolean sourceDestCheck
```
      Indicates whether traffic to or from the instance is validated.
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      Any security groups for the network interface.
    - attachment
```
NetworkInterfaceAttachment attachment
```
      The network interface attachment.
    - association
```
NetworkInterfaceAssociation association
```
      The association information for an Elastic IP associated with the network interface.
    - tagSet
```
com.amazonaws.internal.SdkInternalList<T> tagSet
```
      Any tags assigned to the network interface.
    - privateIpAddresses
```
com.amazonaws.internal.SdkInternalList<T> privateIpAddresses
```
      The private IP addresses associated with the network interface.
    - interfaceType
```
String interfaceType
```
      The type of interface.
- Class com.amazonaws.services.ec2.model.NetworkInterfaceAssociation extends Object implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      The address of the Elastic IP address bound to the network interface.
    - publicDnsName
```
String publicDnsName
```
      The public DNS name.
    - ipOwnerId
```
String ipOwnerId
```
      The ID of the Elastic IP address owner.
    - allocationId
```
String allocationId
```
      The allocation ID.
    - associationId
```
String associationId
```
      The association ID.
- Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachment extends Object implements Serializable
  - Serialized Fields
    - attachmentId
```
String attachmentId
```
      The ID of the network interface attachment.
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - instanceOwnerId
```
String instanceOwnerId
```
      The AWS account ID of the owner of the instance.
    - deviceIndex
```
Integer deviceIndex
```
      The device index of the network interface attachment on the instance.
    - status
```
String status
```
      The attachment state.
    - attachTime
```
Date attachTime
```
      The timestamp indicating when the attachment initiated.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the network interface is deleted when the instance is terminated.
- Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachmentChanges extends Object implements Serializable
  - Serialized Fields
    - attachmentId
```
String attachmentId
```
      The ID of the network interface attachment.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the network interface is deleted when the instance is terminated.
- Class com.amazonaws.services.ec2.model.NetworkInterfacePrivateIpAddress extends Object implements Serializable
  - Serialized Fields
    - privateIpAddress
```
String privateIpAddress
```
      The private IP address.
    - privateDnsName
```
String privateDnsName
```
      The private DNS name.
    - primary
```
Boolean primary
```
      Indicates whether this IP address is the primary private IP address of the network interface.
    - association
```
NetworkInterfaceAssociation association
```
      The association information for an Elastic IP address associated with the network interface.
- Class com.amazonaws.services.ec2.model.Placement extends Object implements Serializable
  - Serialized Fields
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone of the instance.
    - groupName
```
String groupName
```
      The name of the placement group the instance is in (for cluster compute instances).
    - tenancy
```
String tenancy
```
      The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
    - hostId
```
String hostId
```
      The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.
    - affinity
```
String affinity
```
      The affinity setting for the instance on the Dedicated host. This parameter is not supported for the ImportInstance command.
- Class com.amazonaws.services.ec2.model.PlacementGroup extends Object implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      The name of the placement group.
    - strategy
```
String strategy
```
      The placement strategy.
    - state
```
String state
```
      The state of the placement group.
- Class com.amazonaws.services.ec2.model.PortRange extends Object implements Serializable
  - Serialized Fields
    - from
```
Integer from
```
      The first port in the range.
    - to
```
Integer to
```
      The last port in the range.
- Class com.amazonaws.services.ec2.model.PrefixList extends Object implements Serializable
  - Serialized Fields
    - prefixListId
```
String prefixListId
```
      The ID of the prefix.
    - prefixListName
```
String prefixListName
```
      The name of the prefix.
    - cidrs
```
com.amazonaws.internal.SdkInternalList<T> cidrs
```
      The IP address range of the AWS service.
- Class com.amazonaws.services.ec2.model.PrefixListId extends Object implements Serializable
  - Serialized Fields
    - prefixListId
```
String prefixListId
```
      The ID of the prefix.
- Class com.amazonaws.services.ec2.model.PriceSchedule extends Object implements Serializable
  - Serialized Fields
    - term
```
Long term
```
      The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
    - price
```
Double price
```
      The fixed price for the term.
    - currencyCode
```
String currencyCode
```
      The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
    - active
```
Boolean active
```
      The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
      
      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.
- Class com.amazonaws.services.ec2.model.PriceScheduleSpecification extends Object implements Serializable
  - Serialized Fields
    - term
```
Long term
```
      The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.
    - price
```
Double price
```
      The fixed price for the term.
    - currencyCode
```
String currencyCode
```
      The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.
- Class com.amazonaws.services.ec2.model.PricingDetail extends Object implements Serializable
  - Serialized Fields
    - price
```
Double price
```
      The price per instance.
    - count
```
Integer count
```
      The number of reservations available for the price.
- Class com.amazonaws.services.ec2.model.PrivateIpAddressSpecification extends Object implements Serializable
  - Serialized Fields
    - privateIpAddress
```
String privateIpAddress
```
      The private IP addresses.
    - primary
```
Boolean primary
```
      Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.
- Class com.amazonaws.services.ec2.model.ProductCode extends Object implements Serializable
  - Serialized Fields
    - productCodeId
```
String productCodeId
```
      The product code.
    - productCodeType
```
String productCodeType
```
      The type of product code.
- Class com.amazonaws.services.ec2.model.PropagatingVgw extends Object implements Serializable
  - Serialized Fields
    - gatewayId
```
String gatewayId
```
      The ID of the virtual private gateway (VGW).
- Class com.amazonaws.services.ec2.model.PurchaseRequest extends Object implements Serializable
  - Serialized Fields
    - purchaseToken
```
String purchaseToken
```
      The purchase token.
    - instanceCount
```
Integer instanceCount
```
      The number of instances.
- Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - reservedInstancesOfferingId
```
String reservedInstancesOfferingId
```
      The ID of the Reserved Instance offering to purchase.
    - instanceCount
```
Integer instanceCount
```
      The number of Reserved Instances to purchase.
    - limitPrice
```
ReservedInstanceLimitPrice limitPrice
```
      Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
- Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesId
```
String reservedInstancesId
```
      The IDs of the purchased Reserved Instances.
- Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
    - purchaseRequests
```
com.amazonaws.internal.SdkInternalList<T> purchaseRequests
```
      One or more purchase requests.
- Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesResult extends Object implements Serializable
  - Serialized Fields
    - scheduledInstanceSet
```
com.amazonaws.internal.SdkInternalList<T> scheduledInstanceSet
```
      Information about the Scheduled Instances.
- Class com.amazonaws.services.ec2.model.RebootInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceIds
```
com.amazonaws.internal.SdkInternalList<T> instanceIds
```
      One or more instance IDs.
- Class com.amazonaws.services.ec2.model.RecurringCharge extends Object implements Serializable
  - Serialized Fields
    - frequency
```
String frequency
```
      The frequency of the recurring charge.
    - amount
```
Double amount
```
      The amount of the recurring charge.
- Class com.amazonaws.services.ec2.model.Region extends Object implements Serializable
  - Serialized Fields
    - regionName
```
String regionName
```
      The name of the region.
    - endpoint
```
String endpoint
```
      The region service endpoint.
- Class com.amazonaws.services.ec2.model.RegisterImageRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageLocation
```
String imageLocation
```
      The full path to your AMI manifest in Amazon S3 storage.
    - name
```
String name
```
      A name for your AMI.
      
      Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
    - description
```
String description
```
      A description for your AMI.
    - architecture
```
String architecture
```
      The architecture of the AMI.
      
      Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
    - kernelId
```
String kernelId
```
      The ID of the kernel.
    - ramdiskId
```
String ramdiskId
```
      The ID of the RAM disk.
    - rootDeviceName
```
String rootDeviceName
```
      The name of the root device (for example, /dev/sda1, or /dev/xvda).
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      One or more block device mapping entries.
    - virtualizationType
```
String virtualizationType
```
      The type of virtualization.
      
      Default: paravirtual
    - sriovNetSupport
```
String sriovNetSupport
```
      Set to 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.
- Class com.amazonaws.services.ec2.model.RegisterImageResult extends Object implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the newly registered AMI.
- Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - vpcPeeringConnectionId
```
String vpcPeeringConnectionId
```
      The ID of the VPC peering connection.
- Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionResult extends Object implements Serializable
  - Serialized Fields
    - returnValue
```
Boolean returnValue
```
      Returns true if the request succeeds; otherwise, it returns an error.
- Class com.amazonaws.services.ec2.model.ReleaseAddressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      [EC2-Classic] The Elastic IP address. Required for EC2-Classic.
    - allocationId
```
String allocationId
```
      [EC2-VPC] The allocation ID. Required for EC2-VPC.
- Class com.amazonaws.services.ec2.model.ReleaseHostsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - hostIds
```
com.amazonaws.internal.SdkInternalList<T> hostIds
```
      The IDs of the Dedicated hosts you want to release.
- Class com.amazonaws.services.ec2.model.ReleaseHostsResult extends Object implements Serializable
  - Serialized Fields
    - successful
```
com.amazonaws.internal.SdkInternalList<T> successful
```
      The IDs of the Dedicated hosts that were successfully released.
    - unsuccessful
```
com.amazonaws.internal.SdkInternalList<T> unsuccessful
```
      The IDs of the Dedicated hosts that could not be released, including an error message.
- Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - associationId
```
String associationId
```
      The ID of the current association between the original network ACL and the subnet.
    - networkAclId
```
String networkAclId
```
      The ID of the new network ACL to associate with the subnet.
- Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationResult extends Object implements Serializable
  - Serialized Fields
    - newAssociationId
```
String newAssociationId
```
      The ID of the new association.
- Class com.amazonaws.services.ec2.model.ReplaceNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkAclId
```
String networkAclId
```
      The ID of the ACL.
    - ruleNumber
```
Integer ruleNumber
```
      The rule number of the entry to replace.
    - protocol
```
String protocol
```
      The IP protocol. You can specify all or -1 to mean all protocols.
    - ruleAction
```
String ruleAction
```
      Indicates whether to allow or deny the traffic that matches the rule.
    - egress
```
Boolean egress
```
      Indicates whether to replace the egress rule.
      
      Default: If no value is specified, we replace the ingress rule.
    - cidrBlock
```
String cidrBlock
```
      The network range to allow or deny, in CIDR notation.
    - icmpTypeCode
```
IcmpTypeCode icmpTypeCode
```
      ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.
    - portRange
```
PortRange portRange
```
      TCP or UDP protocols: The range of ports the rule applies to. Required if specifying 6 (TCP) or 17 (UDP) for the protocol.
- Class com.amazonaws.services.ec2.model.ReplaceRouteRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
    - destinationCidrBlock
```
String destinationCidrBlock
```
      The CIDR address block used for the destination match. The value you provide must match the CIDR of an existing route in the table.
    - gatewayId
```
String gatewayId
```
      The ID of an Internet gateway or virtual private gateway.
    - instanceId
```
String instanceId
```
      The ID of a NAT instance in your VPC.
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of a network interface.
    - vpcPeeringConnectionId
```
String vpcPeeringConnectionId
```
      The ID of a VPC peering connection.
    - natGatewayId
```
String natGatewayId
```
      The ID of a NAT gateway.
- Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - associationId
```
String associationId
```
      The association ID.
    - routeTableId
```
String routeTableId
```
      The ID of the new route table to associate with the subnet.
- Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationResult extends Object implements Serializable
  - Serialized Fields
    - newAssociationId
```
String newAssociationId
```
      The ID of the new association.
- Class com.amazonaws.services.ec2.model.ReportInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instances
```
com.amazonaws.internal.SdkInternalList<T> instances
```
      One or more instances.
    - status
```
String status
```
      The status of all instances listed.
    - startTime
```
Date startTime
```
      The time at which the reported instance health state began.
    - endTime
```
Date endTime
```
      The time at which the reported instance health state ended.
    - reasonCodes
```
com.amazonaws.internal.SdkInternalList<T> reasonCodes
```
      One or more reason codes that describes the health state of your instance.
      
      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]
    - description
```
String description
```
      Descriptive text about the health state of your instance.
- Class com.amazonaws.services.ec2.model.RequestSpotFleetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotFleetRequestConfig
```
SpotFleetRequestConfigData spotFleetRequestConfig
```
      The configuration for the Spot fleet request.
- Class com.amazonaws.services.ec2.model.RequestSpotFleetResult extends Object implements Serializable
  - Serialized Fields
    - spotFleetRequestId
```
String spotFleetRequestId
```
      The ID of the Spot fleet request.
- Class com.amazonaws.services.ec2.model.RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - spotPrice
```
String spotPrice
```
      The maximum hourly price (bid) for any Spot instance launched to fulfill the request.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
    - instanceCount
```
Integer instanceCount
```
      The maximum number of Spot instances to launch.
      
      Default: 1
    - type
```
String type
```
      The Spot instance request type.
      
      Default: one-time
    - validFrom
```
Date validFrom
```
      The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
      
      Default: The request is effective indefinitely.
    - validUntil
```
Date validUntil
```
      The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.
      
      Default: The request is effective indefinitely.
    - launchGroup
```
String launchGroup
```
      The instance launch group. Launch groups are Spot instances that launch together and terminate together.
      
      Default: Instances are launched and terminated individually
    - availabilityZoneGroup
```
String availabilityZoneGroup
```
      The user-specified name for a logical grouping of bids.
      
      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.
    - blockDurationMinutes
```
Integer blockDurationMinutes
```
      The required duration for the Spot instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
      
      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 launchSpecification
```
- Class com.amazonaws.services.ec2.model.RequestSpotInstancesResult extends Object implements Serializable
  - Serialized Fields
    - spotInstanceRequests
```
com.amazonaws.internal.SdkInternalList<T> spotInstanceRequests
```
      One or more Spot instance requests.
- Class com.amazonaws.services.ec2.model.Reservation extends Object implements Serializable
  - Serialized Fields
    - reservationId
```
String reservationId
```
      The ID of the reservation.
    - ownerId
```
String ownerId
```
      The ID of the AWS account that owns the reservation.
    - requesterId
```
String requesterId
```
      The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).
    - groups
```
com.amazonaws.internal.SdkInternalList<T> groups
```
      [EC2-Classic only] One or more security groups.
    - instances
```
com.amazonaws.internal.SdkInternalList<T> instances
```
      One or more instances.
    - groupNames
```
com.amazonaws.internal.SdkInternalList<T> groupNames
```
      One or more security group names.
- Class com.amazonaws.services.ec2.model.ReservedInstanceLimitPrice extends Object implements Serializable
  - Serialized Fields
    - amount
```
Double amount
```
      Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
    - currencyCode
```
String currencyCode
```
      The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.
- Class com.amazonaws.services.ec2.model.ReservedInstances extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesId
```
String reservedInstancesId
```
      The ID of the Reserved Instance.
    - instanceType
```
String instanceType
```
      The instance type on which the Reserved Instance can be used.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone in which the Reserved Instance can be used.
    - start
```
Date start
```
      The date and time the Reserved Instance started.
    - end
```
Date end
```
      The time when the Reserved Instance expires.
    - duration
```
Long duration
```
      The duration of the Reserved Instance, in seconds.
    - usagePrice
```
Float usagePrice
```
      The usage price of the Reserved Instance, per hour.
    - fixedPrice
```
Float fixedPrice
```
      The purchase price of the Reserved Instance.
    - instanceCount
```
Integer instanceCount
```
      The number of reservations purchased.
    - productDescription
```
String productDescription
```
      The Reserved Instance product platform description.
    - state
```
String state
```
      The state of the Reserved Instance purchase.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the resource.
    - instanceTenancy
```
String instanceTenancy
```
      The tenancy of the instance.
    - currencyCode
```
String currencyCode
```
      The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
    - offeringType
```
String offeringType
```
      The Reserved Instance offering type.
    - recurringCharges
```
com.amazonaws.internal.SdkInternalList<T> recurringCharges
```
      The recurring charge tag assigned to the resource.
- Class com.amazonaws.services.ec2.model.ReservedInstancesConfiguration extends Object implements Serializable
  - Serialized Fields
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone for the modified Reserved Instances.
    - platform
```
String platform
```
      The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.
    - instanceCount
```
Integer instanceCount
```
      The number of modified Reserved Instances.
    - instanceType
```
String instanceType
```
      The instance type for the modified Reserved Instances.
- Class com.amazonaws.services.ec2.model.ReservedInstancesId extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesId
```
String reservedInstancesId
```
      The ID of the Reserved Instance.
- Class com.amazonaws.services.ec2.model.ReservedInstancesListing extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesListingId
```
String reservedInstancesListingId
```
      The ID of the Reserved Instance listing.
    - reservedInstancesId
```
String reservedInstancesId
```
      The ID of the Reserved Instance.
    - createDate
```
Date createDate
```
      The time the listing was created.
    - updateDate
```
Date updateDate
```
      The last modified timestamp of the listing.
    - status
```
String status
```
      The status of the Reserved Instance listing.
    - statusMessage
```
String statusMessage
```
      The reason for the current status of the Reserved Instance listing. The response can be blank.
    - instanceCounts
```
com.amazonaws.internal.SdkInternalList<T> instanceCounts
```
      The number of instances in this state.
    - priceSchedules
```
com.amazonaws.internal.SdkInternalList<T> priceSchedules
```
      The price of the Reserved Instance listing.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the resource.
    - clientToken
```
String clientToken
```
      A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
- Class com.amazonaws.services.ec2.model.ReservedInstancesModification extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesModificationId
```
String reservedInstancesModificationId
```
      A unique ID for the Reserved Instance modification.
    - reservedInstancesIds
```
com.amazonaws.internal.SdkInternalList<T> reservedInstancesIds
```
      The IDs of one or more Reserved Instances.
    - modificationResults
```
com.amazonaws.internal.SdkInternalList<T> modificationResults
```
      Contains target configurations along with their corresponding new Reserved Instance IDs.
    - createDate
```
Date createDate
```
      The time when the modification request was created.
    - updateDate
```
Date updateDate
```
      The time when the modification request was last updated.
    - effectiveDate
```
Date effectiveDate
```
      The time for the modification to become effective.
    - status
```
String status
```
      The status of the Reserved Instances modification request.
    - statusMessage
```
String statusMessage
```
      The reason for the status.
    - clientToken
```
String clientToken
```
      A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.
- Class com.amazonaws.services.ec2.model.ReservedInstancesModificationResult extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesId
```
String reservedInstancesId
```
      The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
    - targetConfiguration
```
ReservedInstancesConfiguration targetConfiguration
```
      The target Reserved Instances configurations supplied as part of the modification request.
- Class com.amazonaws.services.ec2.model.ReservedInstancesOffering extends Object implements Serializable
  - Serialized Fields
    - reservedInstancesOfferingId
```
String reservedInstancesOfferingId
```
      The ID of the Reserved Instance offering.
    - instanceType
```
String instanceType
```
      The instance type on which the Reserved Instance can be used.
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone in which the Reserved Instance can be used.
    - duration
```
Long duration
```
      The duration of the Reserved Instance, in seconds.
    - usagePrice
```
Float usagePrice
```
      The usage price of the Reserved Instance, per hour.
    - fixedPrice
```
Float fixedPrice
```
      The purchase price of the Reserved Instance.
    - productDescription
```
String productDescription
```
      The Reserved Instance product platform description.
    - instanceTenancy
```
String instanceTenancy
```
      The tenancy of the instance.
    - currencyCode
```
String currencyCode
```
      The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.
    - offeringType
```
String offeringType
```
      The Reserved Instance offering type.
    - recurringCharges
```
com.amazonaws.internal.SdkInternalList<T> recurringCharges
```
      The recurring charge tag assigned to the resource.
    - marketplace
```
Boolean marketplace
```
      Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is true.
    - pricingDetails
```
com.amazonaws.internal.SdkInternalList<T> pricingDetails
```
      The pricing details of the Reserved Instance offering.
- Class com.amazonaws.services.ec2.model.ResetImageAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI.
    - attribute
```
String attribute
```
      The attribute to reset (currently you can only reset the launch permission attribute).
- Class com.amazonaws.services.ec2.model.ResetInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - instanceId
```
String instanceId
```
      The ID of the instance.
    - attribute
```
String attribute
```
      The attribute to reset.
- Class com.amazonaws.services.ec2.model.ResetNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - sourceDestCheck
```
String sourceDestCheck
```
      The source/destination checking attribute. Resets the value to true.
- Class com.amazonaws.services.ec2.model.ResetSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - attribute
```
String attribute
```
      The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.
- Class com.amazonaws.services.ec2.model.RestoreAddressToClassicRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - publicIp
```
String publicIp
```
      The Elastic IP address.
- Class com.amazonaws.services.ec2.model.RestoreAddressToClassicResult extends Object implements Serializable
  - Serialized Fields
    - status
```
String status
```
      The move status for the IP address.
    - publicIp
```
String publicIp
```
      The Elastic IP address.
- Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupId
```
String groupId
```
      The ID of the security group.
    - sourceSecurityGroupName
```
String sourceSecurityGroupName
```
      The name of a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
    - sourceSecurityGroupOwnerId
```
String sourceSecurityGroupOwnerId
```
      The AWS account number for a destination security group. To revoke outbound access to a destination security group, we recommend that you use a set of IP permissions instead.
    - ipProtocol
```
String ipProtocol
```
      The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.
    - fromPort
```
Integer fromPort
```
      The start of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
    - toPort
```
Integer toPort
```
      The end of port range for the TCP and UDP protocols, or an ICMP type number. We recommend that you specify the port range in a set of IP permissions instead.
    - cidrIp
```
String cidrIp
```
      The CIDR IP address range. We recommend that you specify the CIDR range in a set of IP permissions instead.
    - ipPermissions
```
com.amazonaws.internal.SdkInternalList<T> ipPermissions
```
      A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.
- Class com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - groupName
```
String groupName
```
      [EC2-Classic, default VPC] The name of the security group.
    - groupId
```
String groupId
```
      The ID of the security group. Required for a security group in a nondefault VPC.
    - sourceSecurityGroupName
```
String sourceSecurityGroupName
```
      [EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
    - sourceSecurityGroupOwnerId
```
String sourceSecurityGroupOwnerId
```
      [EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.
    - ipProtocol
```
String ipProtocol
```
      The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
    - fromPort
```
Integer fromPort
```
      The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all ICMP types.
    - toPort
```
Integer toPort
```
      The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
    - cidrIp
```
String cidrIp
```
      The CIDR IP address range. You can't specify this parameter when specifying a source security group.
    - ipPermissions
```
com.amazonaws.internal.SdkInternalList<T> ipPermissions
```
      A set of IP permissions. You can't specify a source security group and a CIDR IP address range.
- Class com.amazonaws.services.ec2.model.Route extends Object implements Serializable
  - Serialized Fields
    - destinationCidrBlock
```
String destinationCidrBlock
```
      The CIDR block used for the destination match.
    - destinationPrefixListId
```
String destinationPrefixListId
```
      The prefix of the AWS service.
    - gatewayId
```
String gatewayId
```
      The ID of a gateway attached to your VPC.
    - instanceId
```
String instanceId
```
      The ID of a NAT instance in your VPC.
    - instanceOwnerId
```
String instanceOwnerId
```
      The AWS account ID of the owner of the instance.
    - networkInterfaceId
```
String networkInterfaceId
```
      The ID of the network interface.
    - vpcPeeringConnectionId
```
String vpcPeeringConnectionId
```
      The ID of the VPC peering connection.
    - natGatewayId
```
String natGatewayId
```
      The ID of a NAT gateway.
    - state
```
String state
```
      The state of the route. The 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).
    - origin
```
String origin
```
      Describes how the route was created.
      
      CreateRouteTable - The route was automatically created when the route table was created.
      
      CreateRoute - The route was manually added to the route table.
      
      EnableVgwRoutePropagation - The route was propagated by route propagation.
- Class com.amazonaws.services.ec2.model.RouteTable extends Object implements Serializable
  - Serialized Fields
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
    - vpcId
```
String vpcId
```
      The ID of the VPC.
    - routes
```
com.amazonaws.internal.SdkInternalList<T> routes
```
      The routes in the route table.
    - associations
```
com.amazonaws.internal.SdkInternalList<T> associations
```
      The associations between the route table and one or more subnets.
    - tags
```
com.amazonaws.internal.SdkInternalList<T> tags
```
      Any tags assigned to the route table.
    - propagatingVgws
```
com.amazonaws.internal.SdkInternalList<T> propagatingVgws
```
      Any virtual private gateway (VGW) propagating routes.
- Class com.amazonaws.services.ec2.model.RouteTableAssociation extends Object implements Serializable
  - Serialized Fields
    - routeTableAssociationId
```
String routeTableAssociationId
```
      The ID of the association between a route table and a subnet.
    - routeTableId
```
String routeTableId
```
      The ID of the route table.
    - subnetId
```
String subnetId
```
      The ID of the subnet. A subnet ID is not returned for an implicit association.
    - main
```
Boolean main
```
      Indicates whether this is the main route table.
- Class com.amazonaws.services.ec2.model.RunInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - imageId
```
String imageId
```
      The ID of the AMI, which you can get by calling DescribeImages.
    - minCount
```
Integer minCount
```
      The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
      
      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.
    - maxCount
```
Integer maxCount
```
      The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above 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 FAQ.
    - keyName
```
String keyName
```
      The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
      
      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.
    - securityGroups
```
com.amazonaws.internal.SdkInternalList<T> securityGroups
```
      [EC2-Classic, default VPC] One or more security group names. For a nondefault VPC, you must use security group IDs instead.
      
      Default: Amazon EC2 uses the default security group.
    - securityGroupIds
```
com.amazonaws.internal.SdkInternalList<T> securityGroupIds
```
      One or more security group IDs. You can create a security group using CreateSecurityGroup.
      
      Default: Amazon EC2 uses the default security group.
    - userData
```
String userData
```
      Data to configure the instance, or a script to run during instance launch. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). For API calls, the text must be base64-encoded. For command line tools, the encoding is performed for you, and you can load the text from a file.
    - instanceType
```
String instanceType
```
      The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
      
      Default: m1.small
    - placement
```
Placement placement
```
      The placement for the instance.
    - kernelId
```
String kernelId
```
      The ID of the kernel.
      
      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.
    - ramdiskId
```
String ramdiskId
```
      The ID of the RAM disk.
      
      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.
    - blockDeviceMappings
```
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings
```
      The block device mapping.
    - monitoring
```
Boolean monitoring
```
      The monitoring for the instance.
    - subnetId
```
String subnetId
```
      [EC2-VPC] The ID of the subnet to launch the instance into.
    - disableApiTermination
```
Boolean disableApiTermination
```
      If you set this parameter to 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
    - instanceInitiatedShutdownBehavior
```
String instanceInitiatedShutdownBehavior
```
      Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
      
      Default: stop
    - privateIpAddress
```
String privateIpAddress
```
      [EC2-VPC] The primary IP address. You must specify a value from the IP address range of the subnet.
      
      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.
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
      
      Constraints: Maximum 64 ASCII characters
    - additionalInfo
```
String additionalInfo
```
      Reserved.
    - networkInterfaces
```
com.amazonaws.internal.SdkInternalList<T> networkInterfaces
```
      One or more network interfaces.
    - iamInstanceProfile
```
IamInstanceProfileSpecification iamInstanceProfile
```
      The IAM instance profile.
    - ebsOptimized
```
Boolean ebsOptimized
```
      Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
      
      Default: false
- Class com.amazonaws.services.ec2.model.RunInstancesResult extends Object implements Serializable
  - Serialized Fields
    - reservation
```
Reservation reservation
```
      Describes a reservation.
- Class com.amazonaws.services.ec2.model.RunScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientToken
```
String clientToken
```
      Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
    - instanceCount
```
Integer instanceCount
```
      The number of instances.
      
      Default: 1
    - scheduledInstanceId
```
String scheduledInstanceId
```
      The Scheduled Instance ID.
    - launchSpecification
```
ScheduledInstancesLaunchSpecification launchSpecification
```
      The launch specification.
- Class com.amazonaws.services.ec2.model.RunScheduledInstancesResult extends Object implements Serializable
  - Serialized Fields
    - instanceIdSet
```
com.amazonaws.internal.SdkInternalList<T> instanceIdSet
```
      The IDs of the newly launched instances.
- Class com.amazonaws.services.ec2.model.S3Storage extends Object implements Serializable
  - Serialized Fields
    - bucket
```
String bucket
```
      The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.
    - prefix
```
String prefix
```
      The beginning of the file name of the AMI.
    - aWSAccessKeyId
```
String aWSAccessKeyId
```
      The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Managing AWS Access Keys.
    - uploadPolicy
```
String uploadPolicy
```
      A base64-encoded Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf. For command line tools, base64 encoding is performed for you.
    - uploadPolicySignature
```
String uploadPolicySignature
```
      The signature of the Base64 encoded JSON document.
- Class com.amazonaws.services.ec2.model.ScheduledInstance extends Object implements Serializable
  - Serialized Fields
    - scheduledInstanceId
```
String scheduledInstanceId
```
      The Scheduled Instance ID.
    - instanceType
```
String instanceType
```
      The instance type.
    - platform
```
String platform
```
      The platform (Linux/UNIX or Windows).
    - networkPlatform
```
String networkPlatform
```
      The network platform (EC2-Classic or EC2-VPC).
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone.
    - slotDurationInHours
```
Integer slotDurationInHours
```
      The number of hours in the schedule.
    - recurrence
```
ScheduledInstanceRecurrence recurrence
```
      The schedule recurrence.
    - previousSlotEndTime
```
Date previousSlotEndTime
```
      The time that the previous schedule ended or will end.
    - nextSlotStartTime
```
Date nextSlotStartTime
```
      The time for the next schedule to start.
    - hourlyPrice
```
String hourlyPrice
```
      The hourly price for a single instance.
    - totalScheduledInstanceHours
```
Integer totalScheduledInstanceHours
```
      The total number of hours for a single instance for the entire term.
    - instanceCount
```
Integer instanceCount
```
      The number of instances.
    - termStartDate
```
Date termStartDate
```
      The start date for the Scheduled Instance.
    - termEndDate
```
Date termEndDate
```
      The end date for the Scheduled Instance.
    - createDate
```
Date createDate
```
      The date when the Scheduled Instance was purchased.
- Class com.amazonaws.services.ec2.model.ScheduledInstanceAvailability extends Object implements Serializable
  - Serialized Fields
    - instanceType
```
String instanceType
```
      The instance type. You can specify one of the C3, C4, M4, or R3 instance types.
    - platform
```
String platform
```
      The platform (Linux/UNIX or Windows).
    - networkPlatform
```
String networkPlatform
```
      The network platform (EC2-Classic or EC2-VPC).
    - availabilityZone
```
String availabilityZone
```
      The Availability Zone.
    - purchaseToken
```
String purchaseToken
```
      The purchase token. This token expires in two hours.
    - slotDurationInHours
```
Integer slotDurationInHours
```
      The number of hours in the schedule.
    - recurrence
```
ScheduledInstanceRecurrence recurrence
```
      The schedule recurrence.
    - firstSlotStartTime
```
Date firstSlotStartTime
```
      The time period for the first schedule to start.
    - hourlyPrice
```
String hourlyPrice
```
      The hourly price for a single instance.
    - totalScheduledInstanceHours
```
Integer totalScheduledInstanceHours
```
      The total number of hours for a single instance for the entire term.
    - availableInstanceCount
```
Integer availableInstanceCount
```
      The number of available instances.
    - minTermDurationInDays
```
Integer minTermDurationInDays
```
      The minimum term. The only possible value is 365 days.
    - maxTermDurationInDays
```
Integer maxTermDurationInDays
```
      The maximum term. The only possible value is 365 days.
- Class com.amazonaws.services.ec2.model.ScheduledInstanceRecurrence extends Object implements Serializable
  - Serialized Fields
    - frequency
```
String frequency
```
      The frequency (Daily, Weekly, or Monthly).
    - interval
```
Integer interval
```
      The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.
    - occurrenceDaySet
```
com.amazonaws.internal.SdkInternalList<T> occurrenceDaySet
```
      The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).
    - occurrenceRelativeToEnd
```
Boolean occurrenceRelativeToEnd
```
      Indicates whether the occurrence is relative to the end of the specified week or month.
    - occurrenceUnit
```
String occurrenceUnit
```
      The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
- Class com.amazonaws.services.ec2.model.ScheduledInstanceRecurrenceRequest extends Object implements Serializable
  - Serialized Fields
    - frequency
```
String frequency
```
      The frequency (Daily, Weekly, or Monthly).
    - interval
```
Integer interval
```
      The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
    - occurrenceDays
```
com.amazonaws.internal.SdkInternalList<T> occurrenceDays
```
      The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.
    - occurrenceRelativeToEnd
```
Boolean occurrenceRelativeToEnd
```
      Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
    - occurrenceUnit
```
String occurrenceUnit
```
      The unit for 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.
- Class com.amazonaws.services.ec2.model.ScheduledInstancesBlockDeviceMapping extends Object implements Serializable
  - Serialized Fields
    - deviceName
```
String deviceName
```
      The device name exposed to the instance (for example, /dev/sdh or xvdh).
    - noDevice
```
String noDevice
```
      Suppresses the specified device included in the block device mapping of the AMI.
    - virtualName
```
String virtualName
```
      The virtual device name (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.
    - ebs
```
ScheduledInstancesEbs ebs
```
      Parameters used to set up EBS volumes automatically when the instance is launched.
- Class com.amazonaws.services.ec2.model.ScheduledInstancesEbs extends Object implements Serializable
  - Serialized Fields
    - snapshotId
```
String snapshotId
```
      The ID of the snapshot.
    - volumeSize
```
Integer volumeSize
```
      The size of the volume, in GiB.
      
      Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
    - deleteOnTermination
```
Boolean deleteOnTermination
```
      Indicates whether the volume is deleted on instance termination.
    - volumeType
```
String volumeType
```
      The volume type. gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.
      
      Default: standard



Package com.amazonaws.services.ecr.model




Class com.amazonaws.services.ecr.model.AuthorizationData extends Object implements Serializable




Serialized Fields


authorizationToken
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.
 


expiresAt
Date expiresAt

 The Unix time in seconds and milliseconds when the authorization token
 expires. Authorization tokens are valid for 12 hours.
 


proxyEndpoint
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.
 








Class com.amazonaws.services.ecr.model.BatchCheckLayerAvailabilityRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository that is associated with the image layers to
 check.
 


layerDigests
List<E> layerDigests

 The digests of the image layers to check.
 








Class com.amazonaws.services.ecr.model.BatchCheckLayerAvailabilityResult extends Object implements Serializable




Serialized Fields


layers
List<E> layers

 A list of image layer objects corresponding to the image layer references
 in the request.
 


failures
List<E> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecr.model.BatchDeleteImageRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The repository that contains the image to delete.
 


imageIds
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.
 








Class com.amazonaws.services.ecr.model.BatchDeleteImageResult extends Object implements Serializable




Serialized Fields


imageIds
List<E> imageIds

 The image IDs of the deleted images.
 


failures
List<E> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecr.model.BatchGetImageRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The repository that contains the images to describe.
 


imageIds
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.
 








Class com.amazonaws.services.ecr.model.BatchGetImageResult extends Object implements Serializable




Serialized Fields


images
List<E> images

 A list of image objects corresponding to the image references in the
 request.
 


failures
List<E> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecr.model.CompleteLayerUploadRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository to associate with the image layer.
 


uploadId
String uploadId

 The upload ID from a previous InitiateLayerUpload operation to
 associate with the image layer.
 


layerDigests
List<E> layerDigests

 The sha256 digest of the image layer.
 








Class com.amazonaws.services.ecr.model.CompleteLayerUploadResult extends Object implements Serializable




Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


uploadId
String uploadId

 The upload ID associated with the layer.
 


layerDigest
String layerDigest

 The sha256 digest of the image layer.
 








Class com.amazonaws.services.ecr.model.CreateRepositoryRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


repositoryName
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).
 








Class com.amazonaws.services.ecr.model.CreateRepositoryResult extends Object implements Serializable




Serialized Fields


repository
Repository repository








Class com.amazonaws.services.ecr.model.DeleteRepositoryPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository that is associated with the repository policy
 to delete.
 








Class com.amazonaws.services.ecr.model.DeleteRepositoryPolicyResult extends Object implements Serializable




Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


policyText
String policyText

 The JSON repository policy that was deleted from the repository.
 








Class com.amazonaws.services.ecr.model.DeleteRepositoryRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository to delete.
 


force
Boolean force

 Force the deletion of the repository if it contains images.
 








Class com.amazonaws.services.ecr.model.DeleteRepositoryResult extends Object implements Serializable




Serialized Fields


repository
Repository repository








Class com.amazonaws.services.ecr.model.DescribeRepositoriesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryNames
List<E> repositoryNames

 A list of repositories to describe. If this parameter is omitted, then
 all repositories in a registry are described.
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.ecr.model.DescribeRepositoriesResult extends Object implements Serializable




Serialized Fields


repositories
List<E> repositories

 A list of repository objects corresponding to valid repositories.
 


nextToken
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.
 








Class com.amazonaws.services.ecr.model.EmptyUploadException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.GetAuthorizationTokenRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryIds
List<E> registryIds

 A list of AWS account IDs that are associated with the registries for
 which to get authorization tokens. If you do not specify a registry, the
 default registry is assumed.
 








Class com.amazonaws.services.ecr.model.GetAuthorizationTokenResult extends Object implements Serializable




Serialized Fields


authorizationData
List<E> authorizationData

 A list of authorization token data objects that correspond to the
 registryIds values in the request.
 








Class com.amazonaws.services.ecr.model.GetDownloadUrlForLayerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository that is associated with the image layer to
 download.
 


layerDigest
String layerDigest

 The digest of the image layer to download.
 








Class com.amazonaws.services.ecr.model.GetDownloadUrlForLayerResult extends Object implements Serializable




Serialized Fields


downloadUrl
String downloadUrl

 The pre-signed Amazon S3 download URL for the requested layer.
 


layerDigest
String layerDigest

 The digest of the image layer to download.
 








Class com.amazonaws.services.ecr.model.GetRepositoryPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository whose policy you want to retrieve.
 








Class com.amazonaws.services.ecr.model.GetRepositoryPolicyResult extends Object implements Serializable




Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


policyText
String policyText

 The JSON repository policy text associated with the repository.
 








Class com.amazonaws.services.ecr.model.Image extends Object implements Serializable




Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry containing the image.
 


repositoryName
String repositoryName

 The name of the repository associated with the image.
 


imageId
ImageIdentifier imageId

 An object containing the image tag and image digest associated with an
 image.
 


imageManifest
String imageManifest

 The image manifest associated with the image.
 








Class com.amazonaws.services.ecr.model.ImageAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.ImageFailure extends Object implements Serializable




Serialized Fields


imageId
ImageIdentifier imageId

 The image ID associated with the failure.
 


failureCode
String failureCode

 The code associated with the failure.
 


failureReason
String failureReason

 The reason for the failure.
 








Class com.amazonaws.services.ecr.model.ImageIdentifier extends Object implements Serializable




Serialized Fields


imageDigest
String imageDigest

 The sha256 digest of the image manifest.
 


imageTag
String imageTag

 The tag used for the image.
 








Class com.amazonaws.services.ecr.model.InitiateLayerUploadRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
String registryId

 The AWS account ID associated with the registry that you intend to upload
 layers to. If you do not specify a registry, the default registry is
 assumed.
 


repositoryName
String repositoryName

 The name of the repository that you intend to upload layers to.
 








Class com.amazonaws.services.ecr.model.InitiateLayerUploadResult extends Object implements Serializable




Serialized Fields


uploadId
String uploadId

 The upload ID for the layer upload. This parameter is passed to further
 UploadLayerPart and CompleteLayerUpload operations.
 


partSize
Long partSize

 The size, in bytes, that Amazon ECR expects future layer part uploads to
 be.
 








Class com.amazonaws.services.ecr.model.InvalidLayerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.InvalidLayerPartException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


registryId
String registryId

 The registry ID associated with the exception.
 


repositoryName
String repositoryName

 The repository name associated with the exception.
 


uploadId
String uploadId

 The upload ID associated with the exception.
 


lastValidByteReceived
Long lastValidByteReceived

 The last valid byte received from the layer part upload that is
 associated with the exception.
 








Class com.amazonaws.services.ecr.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.Layer extends Object implements Serializable




Serialized Fields


layerDigest
String layerDigest

 The sha256 digest of the image layer.
 


layerAvailability
String layerAvailability

 The availability status of the image layer. Valid values are
 AVAILABLE and UNAVAILABLE.
 


layerSize
Long layerSize

 The size, in bytes, of the image layer.
 








Class com.amazonaws.services.ecr.model.LayerAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.LayerFailure extends Object implements Serializable




Serialized Fields


layerDigest
String layerDigest

 The layer digest associated with the failure.
 


failureCode
String failureCode

 The failure code associated with the failure.
 


failureReason
String failureReason

 The reason for the failure.
 








Class com.amazonaws.services.ecr.model.LayerInaccessibleException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.LayerPartTooSmallException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.LayersNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.ListImagesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The repository whose image IDs are to be listed.
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.ecr.model.ListImagesResult extends Object implements Serializable




Serialized Fields


imageIds
List<E> imageIds

 The list of image IDs for the requested repository.
 


nextToken
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.
 








Class com.amazonaws.services.ecr.model.PutImageRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository in which to put the image.
 


imageManifest
String imageManifest

 The image manifest corresponding to the image to be uploaded.
 








Class com.amazonaws.services.ecr.model.PutImageResult extends Object implements Serializable




Serialized Fields


image
Image image

 Details of the image uploaded.
 








Class com.amazonaws.services.ecr.model.Repository extends Object implements Serializable




Serialized Fields


repositoryArn
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.
 


registryId
String registryId

 The AWS account ID associated with the registry that contains the
 repository.
 


repositoryName
String repositoryName

 The name of the repository.
 








Class com.amazonaws.services.ecr.model.RepositoryAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.RepositoryNotEmptyException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.RepositoryNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.RepositoryPolicyNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.ServerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecr.model.SetRepositoryPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository to receive the policy.
 


policyText
String policyText

 The JSON repository policy text to apply to the repository.
 


force
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.
 








Class com.amazonaws.services.ecr.model.SetRepositoryPolicyResult extends Object implements Serializable




Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


policyText
String policyText

 The JSON repository policy text applied to the repository.
 








Class com.amazonaws.services.ecr.model.UploadLayerPartRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


registryId
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.
 


repositoryName
String repositoryName

 The name of the repository that you are uploading layer parts to.
 


uploadId
String uploadId

 The upload ID from a previous InitiateLayerUpload operation to
 associate with the layer part upload.
 


partFirstByte
Long partFirstByte

 The integer value of the first byte of the layer part.
 


partLastByte
Long partLastByte

 The integer value of the last byte of the layer part.
 


layerPartBlob
ByteBuffer layerPartBlob

 The base64-encoded layer part payload.
 








Class com.amazonaws.services.ecr.model.UploadLayerPartResult extends Object implements Serializable




Serialized Fields


registryId
String registryId

 The registry ID associated with the request.
 


repositoryName
String repositoryName

 The repository name associated with the request.
 


uploadId
String uploadId

 The upload ID associated with the request.
 


lastByteReceived
Long lastByteReceived

 The integer value of the last byte received in the request.
 








Class com.amazonaws.services.ecr.model.UploadNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.ecs.model




Class com.amazonaws.services.ecs.model.Attribute extends Object implements Serializable




Serialized Fields


name
String name

 The name of the container instance attribute.
 


value
String value

 The value of the container instance attribute (at this time, the value
 here is Null, but this could change in future revisions for
 expandability).
 








Class com.amazonaws.services.ecs.model.ClientException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.Cluster extends Object implements Serializable




Serialized Fields


clusterArn
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.
 


clusterName
String clusterName

 A user-generated string that you use to identify your cluster.
 


status
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.
 


registeredContainerInstancesCount
Integer registeredContainerInstancesCount

 The number of container instances registered into the cluster.
 


runningTasksCount
Integer runningTasksCount

 The number of tasks in the cluster that are in the RUNNING
 state.
 


pendingTasksCount
Integer pendingTasksCount

 The number of tasks in the cluster that are in the PENDING
 state.
 


activeServicesCount
Integer activeServicesCount

 The number of services that are running on the cluster in an
 ACTIVE state. You can view these services with
 ListServices.
 








Class com.amazonaws.services.ecs.model.ClusterContainsContainerInstancesException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.ClusterContainsServicesException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.ClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.Container extends Object implements Serializable




Serialized Fields


containerArn
String containerArn

 The Amazon Resource Name (ARN) of the container.
 


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task.
 


name
String name

 The name of the container.
 


lastStatus
String lastStatus

 The last known status of the container.
 


exitCode
Integer exitCode

 The exit code returned from the container.
 


reason
String reason

 A short (255 max characters) human-readable string to provide additional
 detail about a running or stopped container.
 


networkBindings
com.amazonaws.internal.SdkInternalList<T> networkBindings

 The network bindings associated with the container.
 








Class com.amazonaws.services.ecs.model.ContainerDefinition extends Object implements Serializable




Serialized Fields


name
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.
 


image
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.
 
 
 Images in official repositories on Docker Hub use a single name (for
 example, ubuntu or mongo).
 Images in other repositories on Docker Hub are qualified with an
 organization name (for example, amazon/amazon-ecs-agent).
 Images in other online repositories are qualified further by a domain
 name (for example, quay.io/assemblyline/ubuntu).
 


cpu
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:
 
 
 Agent versions less than or equal to 1.1.0: Null and zero CPU
 values are passed to Docker as 0, which Docker then converts to 1,024 CPU
 shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel
 converts to 2 CPU shares.
 Agent versions greater than or equal to 1.2.0: Null, zero, and
 CPU values of 1 are passed to Docker as 2.
 


memory
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.
 


links
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.
 
 


portMappings
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.
 
 


essential
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.
 
 


entryPoint
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.
 


command
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.
 


environment
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.
 
 


mountPoints
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.
 


volumesFrom
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.
 


hostname
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.
 


user
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.
 


workingDirectory
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.
 


disableNetworking
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.
 


privileged
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.
 


readonlyRootFilesystem
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.
 


dnsServers
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.
 


dnsSearchDomains
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.
 


extraHosts
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.
 


dockerSecurityOptions
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.
 
 


dockerLabels
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"
 


ulimits
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 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.
 
 








Class com.amazonaws.services.ecs.model.ContainerInstance extends Object implements Serializable




Serialized Fields


containerInstanceArn
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.
 


ec2InstanceId
String ec2InstanceId

 The EC2 instance ID of the container instance.
 


versionInfo
VersionInfo versionInfo

 The version information for the Amazon ECS container agent and Docker
 daemon running on the container instance.
 


remainingResources
com.amazonaws.internal.SdkInternalList<T> remainingResources

 The remaining resources of the container instance that are available for
 new tasks.
 


registeredResources
com.amazonaws.internal.SdkInternalList<T> registeredResources

 The registered resources on the container instance that are in use by
 current tasks.
 


status
String status

 The status of the container instance. The valid values are
 ACTIVE or INACTIVE. ACTIVE
 indicates that the container instance can accept tasks.
 


agentConnected
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.
 


runningTasksCount
Integer runningTasksCount

 The number of tasks on the container instance that are in the
 RUNNING status.
 


pendingTasksCount
Integer pendingTasksCount

 The number of tasks on the container instance that are in the
 PENDING status.
 


agentUpdateStatus
String agentUpdateStatus

 The status of the most recent agent update. If an update has never been
 requested, this value is NULL.
 


attributes
com.amazonaws.internal.SdkInternalList<T> attributes

 The attributes set for the container instance by the Amazon ECS container
 agent at instance registration.
 








Class com.amazonaws.services.ecs.model.ContainerOverride extends Object implements Serializable




Serialized Fields


name
String name

 The name of the container that receives the override.
 


command
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.
 


environment
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.
 








Class com.amazonaws.services.ecs.model.CreateClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusterName
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.
 








Class com.amazonaws.services.ecs.model.CreateClusterResult extends Object implements Serializable




Serialized Fields


cluster
Cluster cluster

 The full description of your new cluster.
 








Class com.amazonaws.services.ecs.model.CreateServiceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


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.
 


serviceName
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.
 


taskDefinition
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.
 


loadBalancers
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.
 


desiredCount
Integer desiredCount

 The number of instantiations of the specified task definition to place
 and keep running on your cluster.
 


clientToken
String clientToken

 Unique, case-sensitive identifier you provide to ensure the idempotency
 of the request. Up to 32 ASCII characters are allowed.
 


role
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 deploymentConfiguration

 Optional deployment parameters that control how many tasks run during the
 deployment and the ordering of stopping and starting tasks.
 








Class com.amazonaws.services.ecs.model.CreateServiceResult extends Object implements Serializable




Serialized Fields


service
Service service

 The full description of your service following the create call.
 








Class com.amazonaws.services.ecs.model.DeleteClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster to
 delete.
 








Class com.amazonaws.services.ecs.model.DeleteClusterResult extends Object implements Serializable




Serialized Fields


cluster
Cluster cluster

 The full description of the deleted cluster.
 








Class com.amazonaws.services.ecs.model.DeleteServiceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
String cluster

 The name of the cluster that hosts the service to delete. If you do not
 specify a cluster, the default cluster is assumed.
 


service
String service

 The name of the service to delete.
 








Class com.amazonaws.services.ecs.model.DeleteServiceResult extends Object implements Serializable




Serialized Fields


service
Service service

 The full description of the deleted service.
 








Class com.amazonaws.services.ecs.model.Deployment extends Object implements Serializable




Serialized Fields


id
String id

 The ID of the deployment.
 


status
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).
 


taskDefinition
String taskDefinition

 The most recent task definition that was specified for the service to
 use.
 


desiredCount
Integer desiredCount

 The most recent desired count of tasks that was specified for the service
 to deploy or maintain.
 


pendingCount
Integer pendingCount

 The number of tasks in the deployment that are in the
 PENDING status.
 


runningCount
Integer runningCount

 The number of tasks in the deployment that are in the
 RUNNING status.
 


createdAt
Date createdAt

 The Unix time in seconds and milliseconds when the service was created.
 


updatedAt
Date updatedAt

 The Unix time in seconds and milliseconds when the service was last
 updated.
 








Class com.amazonaws.services.ecs.model.DeploymentConfiguration extends Object implements Serializable




Serialized Fields


maximumPercent
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.
 


minimumHealthyPercent
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.
 








Class com.amazonaws.services.ecs.model.DeregisterContainerInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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.
 


containerInstance
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.
 


force
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.
 








Class com.amazonaws.services.ecs.model.DeregisterContainerInstanceResult extends Object implements Serializable




Serialized Fields


containerInstance
ContainerInstance containerInstance








Class com.amazonaws.services.ecs.model.DeregisterTaskDefinitionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


taskDefinition
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.
 








Class com.amazonaws.services.ecs.model.DeregisterTaskDefinitionResult extends Object implements Serializable




Serialized Fields


taskDefinition
TaskDefinition taskDefinition

 The full description of the deregistered task.
 








Class com.amazonaws.services.ecs.model.DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusters
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.
 








Class com.amazonaws.services.ecs.model.DescribeClustersResult extends Object implements Serializable




Serialized Fields


clusters
com.amazonaws.internal.SdkInternalList<T> clusters

 The list of clusters.
 


failures
com.amazonaws.internal.SdkInternalList<T> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecs.model.DescribeContainerInstancesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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.
 


containerInstances
com.amazonaws.internal.SdkInternalList<T> containerInstances

 A space-separated list of container instance IDs or full Amazon Resource
 Name (ARN) entries.
 








Class com.amazonaws.services.ecs.model.DescribeContainerInstancesResult extends Object implements Serializable




Serialized Fields


containerInstances
com.amazonaws.internal.SdkInternalList<T> containerInstances

 The list of container instances.
 


failures
com.amazonaws.internal.SdkInternalList<T> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecs.model.DescribeServicesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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.
 


services
com.amazonaws.internal.SdkInternalList<T> services

 A list of services to describe.
 








Class com.amazonaws.services.ecs.model.DescribeServicesResult extends Object implements Serializable




Serialized Fields


services
com.amazonaws.internal.SdkInternalList<T> services

 The list of services described.
 


failures
com.amazonaws.internal.SdkInternalList<T> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecs.model.DescribeTaskDefinitionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


taskDefinition
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.
 








Class com.amazonaws.services.ecs.model.DescribeTaskDefinitionResult extends Object implements Serializable




Serialized Fields


taskDefinition
TaskDefinition taskDefinition

 The full task definition description.
 








Class com.amazonaws.services.ecs.model.DescribeTasksRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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.
 


tasks
com.amazonaws.internal.SdkInternalList<T> tasks

 A space-separated list of task IDs or full Amazon Resource Name (ARN)
 entries.
 








Class com.amazonaws.services.ecs.model.DescribeTasksResult extends Object implements Serializable




Serialized Fields


tasks
com.amazonaws.internal.SdkInternalList<T> tasks

 The list of tasks.
 


failures
com.amazonaws.internal.SdkInternalList<T> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecs.model.DiscoverPollEndpointRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


containerInstance
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.
 


cluster
String cluster

 The cluster that the container instance belongs to.
 








Class com.amazonaws.services.ecs.model.DiscoverPollEndpointResult extends Object implements Serializable




Serialized Fields


endpoint
String endpoint

 The endpoint for the Amazon ECS agent to poll.
 


telemetryEndpoint
String telemetryEndpoint

 The telemetry endpoint for the Amazon ECS agent.
 








Class com.amazonaws.services.ecs.model.Failure extends Object implements Serializable




Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the failed resource.
 


reason
String reason

 The reason for the failure.
 








Class com.amazonaws.services.ecs.model.HostEntry extends Object implements Serializable




Serialized Fields


hostname
String hostname

 The hostname to use in the /etc/hosts entry.
 


ipAddress
String ipAddress

 The IP address to use in the /etc/hosts entry.
 








Class com.amazonaws.services.ecs.model.HostVolumeProperties extends Object implements Serializable




Serialized Fields


sourcePath
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.
 








Class com.amazonaws.services.ecs.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.KeyValuePair extends Object implements Serializable




Serialized Fields


name
String name

 The name of the key value pair. For environment variables, this is the
 name of the environment variable.
 


value
String value

 The value of the key value pair. For environment variables, this is the
 value of the environment variable.
 








Class com.amazonaws.services.ecs.model.ListClustersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.ecs.model.ListClustersResult extends Object implements Serializable




Serialized Fields


clusterArns
com.amazonaws.internal.SdkInternalList<T> clusterArns

 The list of full Amazon Resource Name (ARN) entries for each cluster
 associated with your account.
 


nextToken
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.
 








Class com.amazonaws.services.ecs.model.ListContainerInstancesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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..
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.ecs.model.ListContainerInstancesResult extends Object implements Serializable




Serialized Fields


containerInstanceArns
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.
 


nextToken
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.
 








Class com.amazonaws.services.ecs.model.ListServicesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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..
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.ecs.model.ListServicesResult extends Object implements Serializable




Serialized Fields


serviceArns
com.amazonaws.internal.SdkInternalList<T> serviceArns

 The list of full Amazon Resource Name (ARN) entries for each service
 associated with the specified cluster.
 


nextToken
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.
 








Class com.amazonaws.services.ecs.model.ListTaskDefinitionFamiliesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


familyPrefix
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.
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.ecs.model.ListTaskDefinitionFamiliesResult extends Object implements Serializable




Serialized Fields


families
com.amazonaws.internal.SdkInternalList<T> families

 The list of task definition family names that match the
 ListTaskDefinitionFamilies request.
 


nextToken
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.
 








Class com.amazonaws.services.ecs.model.ListTaskDefinitionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


familyPrefix
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.
 


status
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.
 


sort
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.
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.ecs.model.ListTaskDefinitionsResult extends Object implements Serializable




Serialized Fields


taskDefinitionArns
com.amazonaws.internal.SdkInternalList<T> taskDefinitionArns

 The list of task definition Amazon Resource Name (ARN) entries for the
 ListTaskDefinitions request.
 


nextToken
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.
 








Class com.amazonaws.services.ecs.model.ListTasksRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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..
 


containerInstance
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.
 


family
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.
 


nextToken
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.
 


maxResults
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.
 


startedBy
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.
 


serviceName
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.
 


desiredStatus
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.
 








Class com.amazonaws.services.ecs.model.ListTasksResult extends Object implements Serializable




Serialized Fields


taskArns
com.amazonaws.internal.SdkInternalList<T> taskArns

 The list of task Amazon Resource Name (ARN) entries for the
 ListTasks request.
 


nextToken
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.
 








Class com.amazonaws.services.ecs.model.LoadBalancer extends Object implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


containerName
String containerName

 The name of the container (as it appears in a container definition) to
 associate with the load balancer.
 


containerPort
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.
 








Class com.amazonaws.services.ecs.model.LogConfiguration extends Object implements Serializable




Serialized Fields


logDriver
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"
 


options
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"
 








Class com.amazonaws.services.ecs.model.MissingVersionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.MountPoint extends Object implements Serializable




Serialized Fields


sourceVolume
String sourceVolume

 The name of the volume to mount.
 


containerPath
String containerPath

 The path on the container to mount the host volume at.
 


readOnly
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.
 








Class com.amazonaws.services.ecs.model.NetworkBinding extends Object implements Serializable




Serialized Fields


bindIP
String bindIP

 The IP address that the container is bound to on the container instance.
 


containerPort
Integer containerPort

 The port number on the container that is be used with the network
 binding.
 


hostPort
Integer hostPort

 The port number on the host that is used with the network binding.
 


protocol
String protocol

 The protocol used for the network binding.
 








Class com.amazonaws.services.ecs.model.NoUpdateAvailableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.PortMapping extends Object implements Serializable




Serialized Fields


containerPort
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).
 


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).
 


protocol
String protocol

 The protocol used for the port mapping. Valid values are tcp
 and udp. The default is tcp.
 








Class com.amazonaws.services.ecs.model.RegisterContainerInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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..
 


instanceIdentityDocument
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/
 


instanceIdentityDocumentSignature
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/
 


totalResources
com.amazonaws.internal.SdkInternalList<T> totalResources

 The resources available on the instance.
 


versionInfo
VersionInfo versionInfo

 The version information for the Amazon ECS container agent and Docker
 daemon running on the container instance.
 


containerInstanceArn
String containerInstanceArn

 The Amazon Resource Name (ARN) of the container instance (if it was
 previously registered).
 


attributes
com.amazonaws.internal.SdkInternalList<T> attributes

 The container instance attributes that this container instance supports.
 








Class com.amazonaws.services.ecs.model.RegisterContainerInstanceResult extends Object implements Serializable




Serialized Fields


containerInstance
ContainerInstance containerInstance








Class com.amazonaws.services.ecs.model.RegisterTaskDefinitionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


family
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.
 


containerDefinitions
com.amazonaws.internal.SdkInternalList<T> containerDefinitions

 A list of container definitions in JSON format that describe the
 different containers that make up your task.
 


volumes
com.amazonaws.internal.SdkInternalList<T> volumes

 A list of volume definitions in JSON format that containers in your task
 may use.
 








Class com.amazonaws.services.ecs.model.RegisterTaskDefinitionResult extends Object implements Serializable




Serialized Fields


taskDefinition
TaskDefinition taskDefinition

 The full description of the registered task definition.
 








Class com.amazonaws.services.ecs.model.Resource extends Object implements Serializable




Serialized Fields


name
String name

 The name of the resource, such as CPU, MEMORY,
 PORTS, or a user-defined resource.
 


type
String type

 The type of the resource, such as INTEGER,
 DOUBLE, LONG, or STRINGSET.
 


doubleValue
Double doubleValue

 When the doubleValue type is set, the value of the resource
 must be a double precision floating-point type.
 


longValue
Long longValue

 When the longValue type is set, the value of the resource
 must be an extended precision floating-point type.
 


integerValue
Integer integerValue

 When the integerValue type is set, the value of the resource
 must be an integer.
 


stringSetValue
com.amazonaws.internal.SdkInternalList<T> stringSetValue

 When the stringSetValue type is set, the value of the
 resource must be a string type.
 








Class com.amazonaws.services.ecs.model.RunTaskRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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..
 


taskDefinition
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.
 


overrides
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.
 
 


count
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.
 
 


startedBy
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.
 








Class com.amazonaws.services.ecs.model.RunTaskResult extends Object implements Serializable




Serialized Fields


tasks
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.
 


failures
com.amazonaws.internal.SdkInternalList<T> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecs.model.ServerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.Service extends Object implements Serializable




Serialized Fields


serviceArn
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.
 


serviceName
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.
 


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the of the cluster that hosts the
 service.
 


loadBalancers
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.
 


status
String status

 The status of the service. The valid values are ACTIVE,
 DRAINING, or INACTIVE.
 


desiredCount
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.
 


runningCount
Integer runningCount

 The number of tasks in the cluster that are in the RUNNING
 state.
 


pendingCount
Integer pendingCount

 The number of tasks in the cluster that are in the PENDING
 state.
 


taskDefinition
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 deploymentConfiguration

 Optional deployment parameters that control how many tasks run during the
 deployment and the ordering of stopping and starting tasks.
 


deployments
com.amazonaws.internal.SdkInternalList<T> deployments

 The current state of deployments for the service.
 


roleArn
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.
 


events
com.amazonaws.internal.SdkInternalList<T> events

 The event stream for your service. A maximum of 100 of the latest events
 are displayed.
 








Class com.amazonaws.services.ecs.model.ServiceEvent extends Object implements Serializable




Serialized Fields


id
String id

 The ID string of the event.
 


createdAt
Date createdAt

 The Unix time in seconds and milliseconds when the event was triggered.
 


message
String message

 The event message.
 








Class com.amazonaws.services.ecs.model.ServiceNotActiveException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.ServiceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.StartTaskRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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..
 


taskDefinition
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.
 


overrides
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.
 
 


containerInstances
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.
 
 


startedBy
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.
 








Class com.amazonaws.services.ecs.model.StartTaskResult extends Object implements Serializable




Serialized Fields


tasks
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.
 


failures
com.amazonaws.internal.SdkInternalList<T> failures

 Any failures associated with the call.
 








Class com.amazonaws.services.ecs.model.StopTaskRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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..
 


task
String task

 The task ID or full Amazon Resource Name (ARN) entry of the task to stop.
 


reason
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.
 








Class com.amazonaws.services.ecs.model.StopTaskResult extends Object implements Serializable




Serialized Fields


task
Task task








Class com.amazonaws.services.ecs.model.SubmitContainerStateChangeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that
 hosts the container.
 


task
String task

 The task ID or full Amazon Resource Name (ARN) of the task that hosts the
 container.
 


containerName
String containerName

 The name of the container.
 


status
String status

 The status of the state change request.
 


exitCode
Integer exitCode

 The exit code returned for the state change request.
 


reason
String reason

 The reason for the state change request.
 


networkBindings
com.amazonaws.internal.SdkInternalList<T> networkBindings

 The network bindings of the container.
 








Class com.amazonaws.services.ecs.model.SubmitContainerStateChangeResult extends Object implements Serializable




Serialized Fields


acknowledgment
String acknowledgment

 Acknowledgement of the state change.
 








Class com.amazonaws.services.ecs.model.SubmitTaskStateChangeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
String cluster

 The short name or full Amazon Resource Name (ARN) of the cluster that
 hosts the task.
 


task
String task

 The task ID or full Amazon Resource Name (ARN) of the task in the state
 change request.
 


status
String status

 The status of the state change request.
 


reason
String reason

 The reason for the state change request.
 








Class com.amazonaws.services.ecs.model.SubmitTaskStateChangeResult extends Object implements Serializable




Serialized Fields


acknowledgment
String acknowledgment

 Acknowledgement of the state change.
 








Class com.amazonaws.services.ecs.model.Task extends Object implements Serializable




Serialized Fields


taskArn
String taskArn

 The Amazon Resource Name (ARN) of the task.
 


clusterArn
String clusterArn

 The Amazon Resource Name (ARN) of the of the cluster that hosts the task.
 


taskDefinitionArn
String taskDefinitionArn

 The Amazon Resource Name (ARN) of the of the task definition that creates
 the task.
 


containerInstanceArn
String containerInstanceArn

 The Amazon Resource Name (ARN) of the container instances that host the
 task.
 


overrides
TaskOverride overrides

 One or more container overrides.
 


lastStatus
String lastStatus

 The last known status of the task.
 


desiredStatus
String desiredStatus

 The desired status of the task.
 


containers
com.amazonaws.internal.SdkInternalList<T> containers

 The containers associated with the task.
 


startedBy
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.
 


stoppedReason
String stoppedReason

 The reason the task was stopped.
 


createdAt
Date createdAt

 The Unix time in seconds and milliseconds when the task was created (the
 task entered the PENDING state).
 


startedAt
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).
 


stoppedAt
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).
 








Class com.amazonaws.services.ecs.model.TaskDefinition extends Object implements Serializable




Serialized Fields


taskDefinitionArn
String taskDefinitionArn

 The full Amazon Resource Name (ARN) of the of the task definition.
 


containerDefinitions
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.
 


family
String family

 The family of your task definition, used as the definition name.
 


revision
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).
 


volumes
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.
 


status
String status

 The status of the task definition.
 


requiresAttributes
com.amazonaws.internal.SdkInternalList<T> requiresAttributes

 The container instance attributes required by your task.
 








Class com.amazonaws.services.ecs.model.TaskOverride extends Object implements Serializable




Serialized Fields


containerOverrides
com.amazonaws.internal.SdkInternalList<T> containerOverrides

 One or more container overrides sent to a task.
 








Class com.amazonaws.services.ecs.model.Ulimit extends Object implements Serializable




Serialized Fields


name
String name

 The type of the ulimit.
 


softLimit
Integer softLimit

 The soft limit for the ulimit type.
 


hardLimit
Integer hardLimit

 The hard limit for the ulimit type.
 








Class com.amazonaws.services.ecs.model.UpdateContainerAgentRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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.
 


containerInstance
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.
 








Class com.amazonaws.services.ecs.model.UpdateContainerAgentResult extends Object implements Serializable




Serialized Fields


containerInstance
ContainerInstance containerInstance








Class com.amazonaws.services.ecs.model.UpdateInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.ecs.model.UpdateServiceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cluster
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.
 


service
String service

 The name of the service to update.
 


desiredCount
Integer desiredCount

 The number of instantiations of the task to place and keep running in
 your service.
 


taskDefinition
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 deploymentConfiguration

 Optional deployment parameters that control how many tasks run during the
 deployment and the ordering of stopping and starting tasks.
 








Class com.amazonaws.services.ecs.model.UpdateServiceResult extends Object implements Serializable




Serialized Fields


service
Service service

 The full description of your service following the update call.
 








Class com.amazonaws.services.ecs.model.VersionInfo extends Object implements Serializable




Serialized Fields


agentVersion
String agentVersion

 The version number of the Amazon ECS container agent.
 


agentHash
String agentHash

 The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-
 agent  GitHub repository.
 


dockerVersion
String dockerVersion

 The Docker version running on the container instance.
 








Class com.amazonaws.services.ecs.model.Volume extends Object implements Serializable




Serialized Fields


name
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.
 


host
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.
 








Class com.amazonaws.services.ecs.model.VolumeFrom extends Object implements Serializable




Serialized Fields


sourceContainer
String sourceContainer

 The name of the container to mount volumes from.
 


readOnly
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.
 








Package com.amazonaws.services.elasticache.model




Class com.amazonaws.services.elasticache.model.AddTagsToResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceName
String resourceName
The Amazon Resource Name (ARN) of the resource to which the tags are
 to be added, for example
 arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
 or
 arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
 For more information on ARNs, go to Amazon
 Resource Names (ARNs) and AWS Service Namespaces.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of cost allocation tags to be added to this resource. A tag is
 a key-value pair. A tag key must be accompanied by a tag value.








Class com.amazonaws.services.elasticache.model.AddTagsToResourceResult extends Object implements Serializable




Serialized Fields


tagList
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
A list of cost allocation tags as key-value pairs.








Class com.amazonaws.services.elasticache.model.AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.AuthorizationNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.AuthorizeCacheSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName
The cache security group which will allow network ingress.


eC2SecurityGroupName
String eC2SecurityGroupName
The Amazon EC2 security group to be authorized for ingress to the
 cache security group.


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId
The AWS account number of the Amazon EC2 security group owner. Note
 that this is not the same thing as an AWS access key ID - you must
 provide a valid AWS account number for this parameter.








Class com.amazonaws.services.elasticache.model.AvailabilityZone extends Object implements Serializable




Serialized Fields


name
String name
The name of the Availability Zone.








Class com.amazonaws.services.elasticache.model.CacheCluster extends Object implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The user-supplied identifier of the cache cluster. This identifier is
 a unique key that identifies a cache cluster.


configurationEndpoint
Endpoint configurationEndpoint
Represents the information required for client programs to connect to
 a cache node.


clientDownloadLandingPage
String clientDownloadLandingPage
The URL of the web page where you can download the latest ElastiCache
 client library.


cacheNodeType
String cacheNodeType
The name of the compute and memory capacity node type for the cache
 cluster. Valid node types are as follows: 
 General purpose:
  Current generation: cache.t2.micro,
 cache.t2.small, cache.t2.medium,
 cache.m3.medium, cache.m3.large,
 cache.m3.xlarge, cache.m3.2xlarge
 Previous generation: cache.t1.micro,
 cache.m1.small, cache.m1.medium,
 cache.m1.large, cache.m1.xlarge
 
 Compute optimized: cache.c1.xlarge
 Memory optimized  Current generation:
 cache.r3.large, cache.r3.xlarge,
 cache.r3.2xlarge, cache.r3.4xlarge,
 cache.r3.8xlarge
 Previous generation:
 cache.m2.xlarge, cache.m2.2xlarge,
 cache.m2.4xlarge
 
 
 Notes:
 
 All t2 instances are created in an Amazon Virtual Private
 Cloud (VPC).
 Redis backup/restore is not supported for t2
 instances.
 Redis Append-only files (AOF) functionality is not
 supported for t1 or t2 instances.
 
 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.


engine
String engine
The name of the cache engine (memcached or redis) to be
 used for this cache cluster.


engineVersion
String engineVersion
The version of the cache engine that is used in this cache cluster.


cacheClusterStatus
String cacheClusterStatus
The current state of this cache cluster, one of the following values:
 available, creating, deleted, deleting,
 incompatible-network, modifying, rebooting cache
 cluster nodes, restore-failed, or snapshotting.


numCacheNodes
Integer numCacheNodes
The number of cache nodes in the cache cluster. For clusters
 running Redis, this value must be 1. For clusters running Memcached,
 this value must be between 1 and 20.


preferredAvailabilityZone
String preferredAvailabilityZone
The name of the Availability Zone in which the cache cluster is
 located or "Multiple" if the cache nodes are located in different
 Availability Zones.


cacheClusterCreateTime
Date cacheClusterCreateTime
The date and time when the cache cluster was created.


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
 cluster is performed. It is specified as a range in the format
 ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
 window is a 60 minute period. Valid values for ddd are:
  sun
 mon
 tue
 wed
 thu
 fri
 sat
 
 Example:
 sun:05:00-sun:09:00


pendingModifiedValues
PendingModifiedValues pendingModifiedValues
A group of settings that will be applied to the cache cluster in the
 future, or that are currently being applied.


notificationConfiguration
NotificationConfiguration notificationConfiguration
Describes a notification topic and its status. Notification topics are
 used for publishing ElastiCache events to subscribers using Amazon
 Simple Notification Service (SNS).


cacheSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
A list of cache security group elements, composed of name and status
 sub-elements.


cacheParameterGroup
CacheParameterGroupStatus cacheParameterGroup
The status of the cache parameter group.


cacheSubnetGroupName
String cacheSubnetGroupName
The name of the cache subnet group associated with the cache cluster.


cacheNodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodes
A list of cache nodes that are members of the cache cluster.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.


securityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroups
A list of VPC Security Groups associated with the cache cluster.


replicationGroupId
String replicationGroupId
The replication group to which this cache cluster belongs. If this
 field is empty, the cache cluster is not associated with any
 replication group.


snapshotRetentionLimit
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic cache
 cluster snapshots before deleting them. For example, if you set
 SnapshotRetentionLimit to 5, then a snapshot that was taken
 today will be retained for 5 days before being deleted.
 Important
If the value of SnapshotRetentionLimit is set
 to zero (0), backups are turned off.


snapshotWindow
String snapshotWindow
The daily time range (in UTC) during which ElastiCache will begin
 taking a daily snapshot of your cache cluster. Example:
 05:00-09:00








Class com.amazonaws.services.elasticache.model.CacheClusterAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheEngineVersion extends Object implements Serializable




Serialized Fields


engine
String engine
The name of the cache engine.


engineVersion
String engineVersion
The version number of the cache engine.


cacheParameterGroupFamily
String cacheParameterGroupFamily
The name of the cache parameter group family associated with this
 cache engine.


cacheEngineDescription
String cacheEngineDescription
The description of the cache engine.


cacheEngineVersionDescription
String cacheEngineVersionDescription
The description of the cache engine version.








Class com.amazonaws.services.elasticache.model.CacheNode extends Object implements Serializable




Serialized Fields


cacheNodeId
String cacheNodeId
The cache node identifier. A node ID is a numeric identifier (0001,
 0002, etc.). The combination of cluster ID and node ID uniquely
 identifies every cache node used in a customer's AWS account.


cacheNodeStatus
String cacheNodeStatus
The current state of this cache node.


cacheNodeCreateTime
Date cacheNodeCreateTime
The date and time when the cache node was created.


endpoint
Endpoint endpoint
The hostname for connecting to this cache node.


parameterGroupStatus
String parameterGroupStatus
The status of the parameter group applied to this cache node.


sourceCacheNodeId
String sourceCacheNodeId
The ID of the primary node to which this read replica node is
 synchronized. If this field is empty, then this node is not associated
 with a primary cache cluster.


customerAvailabilityZone
String customerAvailabilityZone
The Availability Zone where this node was created and now resides.








Class com.amazonaws.services.elasticache.model.CacheNodeTypeSpecificParameter extends Object implements Serializable




Serialized Fields


parameterName
String parameterName
The name of the parameter.


description
String description
A description of the parameter.


source
String source
The source of the parameter value.


dataType
String dataType
The valid data type for the parameter.


allowedValues
String allowedValues
The valid range of values for the parameter.


isModifiable
Boolean isModifiable
Indicates whether (true) or not (false) the
 parameter can be modified. Some parameters have security or
 operational implications that prevent them from being changed.


minimumEngineVersion
String minimumEngineVersion
The earliest cache engine version to which the parameter can apply.


cacheNodeTypeSpecificValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificValues
A list of cache node types and their corresponding values for this
 parameter.








Class com.amazonaws.services.elasticache.model.CacheNodeTypeSpecificValue extends Object implements Serializable




Serialized Fields


cacheNodeType
String cacheNodeType
The cache node type for which this value applies.


value
String value
The value for the cache node type.








Class com.amazonaws.services.elasticache.model.CacheParameterGroup extends Object implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group.


cacheParameterGroupFamily
String cacheParameterGroupFamily
The name of the cache parameter group family that this cache parameter
 group is compatible with.


description
String description
The description for this cache parameter group.








Class com.amazonaws.services.elasticache.model.CacheParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheParameterGroupStatus extends Object implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group.


parameterApplyStatus
String parameterApplyStatus
The status of parameter updates.


cacheNodeIdsToReboot
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
A list of the cache node IDs which need to be rebooted for parameter
 changes to be applied. A node ID is a numeric identifier (0001, 0002,
 etc.).








Class com.amazonaws.services.elasticache.model.CacheSecurityGroup extends Object implements Serializable




Serialized Fields


ownerId
String ownerId
The AWS account ID of the cache security group owner.


cacheSecurityGroupName
String cacheSecurityGroupName
The name of the cache security group.


description
String description
The description of the cache security group.


eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
A list of Amazon EC2 security groups that are associated with this
 cache security group.








Class com.amazonaws.services.elasticache.model.CacheSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheSecurityGroupMembership extends Object implements Serializable




Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName
The name of the cache security group.


status
String status
The membership status in the cache security group. The status changes
 when a cache security group is modified, or when the cache security
 groups assigned to a cache cluster are modified.








Class com.amazonaws.services.elasticache.model.CacheSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheSubnetGroup extends Object implements Serializable




Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName
The name of the cache subnet group.


cacheSubnetGroupDescription
String cacheSubnetGroupDescription
The description of the cache subnet group.


vpcId
String vpcId
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
 subnet group.


subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
A list of subnets associated with the cache subnet group.








Class com.amazonaws.services.elasticache.model.CacheSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheSubnetGroupInUseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CacheSubnetQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ClusterQuotaForCustomerExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceSnapshotName
String sourceSnapshotName
The name of an existing snapshot from which to copy.


targetSnapshotName
String targetSnapshotName
A name for the copied snapshot.








Class com.amazonaws.services.elasticache.model.CreateCacheClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The node group identifier. This parameter is stored as a lowercase
 string. Constraints: 
 A name must contain from 1 to 20
 alphanumeric characters or hyphens.
 The first character must
 be a letter.
 A name cannot end with a hyphen or contain two
 consecutive hyphens.
 


replicationGroupId
String replicationGroupId
The ID of the replication group to which this cache cluster should
 belong. If this parameter is specified, the cache cluster will be
 added to the specified replication group as a read replica; otherwise,
 the cache cluster will be a standalone primary that is not part of any
 replication group. 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.


aZMode
String aZMode
Specifies whether the nodes in this Memcached node group are created
 in a single Availability Zone or created across multiple Availability
 Zones in the cluster's region. 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


preferredAvailabilityZone
String preferredAvailabilityZone
The EC2 Availability Zone in which the cache cluster will be created.
 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.


preferredAvailabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredAvailabilityZones
A list of the Availability Zones in which cache nodes will be created.
 The order of the zones in the list is not important. 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


numCacheNodes
Integer numCacheNodes
The initial number of cache nodes that the cache cluster will have.
 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/.


cacheNodeType
String cacheNodeType
The compute and memory capacity of the nodes in the node group.
 Valid node types are as follows: 
 General purpose: 
 Current generation: cache.t2.micro,
 cache.t2.small, cache.t2.medium,
 cache.m3.medium, cache.m3.large,
 cache.m3.xlarge, cache.m3.2xlarge
 Previous generation: cache.t1.micro,
 cache.m1.small, cache.m1.medium,
 cache.m1.large, cache.m1.xlarge
 
 Compute optimized: cache.c1.xlarge
 Memory optimized  Current generation:
 cache.r3.large, cache.r3.xlarge,
 cache.r3.2xlarge, cache.r3.4xlarge,
 cache.r3.8xlarge
 Previous generation:
 cache.m2.xlarge, cache.m2.2xlarge,
 cache.m2.4xlarge
 
 
 Notes:
 
 All t2 instances are created in an Amazon Virtual Private
 Cloud (VPC).
 Redis backup/restore is not supported for t2
 instances.
 Redis Append-only files (AOF) functionality is not
 supported for t1 or t2 instances.
 
 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.


engine
String engine
The name of the cache engine to be used for this cache cluster.
 Valid values for this parameter are: 
memcached |
 redis


engineVersion
String engineVersion
The version number of the cache engine to be used for this cache
 cluster. To view the supported cache engine versions, use the
 DescribeCacheEngineVersions action. Important: You
 can upgrade to a newer engine version (see Selecting
 a Cache Engine and Version), but you cannot downgrade to an
 earlier engine version. If you want to use an earlier engine version,
 you must delete the existing cache cluster or replication group and
 create it anew with the earlier engine version.


cacheParameterGroupName
String cacheParameterGroupName
The name of the parameter group to associate with this cache cluster.
 If this argument is omitted, the default parameter group for the
 specified engine is used.


cacheSubnetGroupName
String cacheSubnetGroupName
The name of the subnet group to be used for the cache cluster. Use
 this parameter only when you are creating a cache cluster in an Amazon
 Virtual Private Cloud (VPC).


cacheSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
A list of security group names to associate with this cache cluster.
 Use this parameter only when you are creating a cache cluster
 outside of an Amazon Virtual Private Cloud (VPC).


securityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
One or more VPC security groups associated with the cache cluster.
 Use this parameter only when you are creating a cache cluster in an
 Amazon Virtual Private Cloud (VPC).


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of cost allocation tags to be added to this resource. A tag is
 a key-value pair. A tag key must be accompanied by a tag value.


snapshotArns
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
A single-element string list containing an Amazon Resource Name (ARN)
 that uniquely identifies a Redis RDB snapshot file stored in Amazon
 S3. The snapshot file will be used to populate the node group. The
 Amazon S3 object name in the ARN cannot contain any commas.
 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


snapshotName
String snapshotName
The name of a snapshot from which to restore data into the new node
 group. The snapshot status changes to restoring while the
 new node group is being created. Note: This parameter is
 only valid if the Engine parameter is redis.


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
 cluster is performed. It is specified as a range in the format
 ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
 window is a 60 minute period. Valid values for ddd are:
  sun
 mon
 tue
 wed
 thu
 fri
 sat
 
 Example:
 sun:05:00-sun:09:00


port
Integer port
The port number on which each of the cache nodes will accept
 connections.


notificationTopicArn
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification
 Service (SNS) topic to which notifications will be sent. The
 Amazon SNS topic owner must be the same as the cache cluster
 owner.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.


snapshotRetentionLimit
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic
 snapshots before deleting them. For example, if you set
 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).


snapshotWindow
String snapshotWindow
The daily time range (in UTC) during which ElastiCache will begin
 taking a daily snapshot of your node group. 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.








Class com.amazonaws.services.elasticache.model.CreateCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
A user-specified name for the cache parameter group.


cacheParameterGroupFamily
String cacheParameterGroupFamily
The name of the cache parameter group family the cache parameter group
 can be used with. Valid values are: memcached1.4 |
 redis2.6 | redis2.8


description
String description
A user-specified description for the cache parameter group.








Class com.amazonaws.services.elasticache.model.CreateCacheSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName
A name for the cache security group. This value is stored as a
 lowercase string. Constraints: Must contain no more than 255
 alphanumeric characters. Cannot be the word "Default". 
Example:
 mysecuritygroup


description
String description
A description for the cache security group.








Class com.amazonaws.services.elasticache.model.CreateCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName
A name for the cache subnet group. This value is stored as a lowercase
 string. Constraints: Must contain no more than 255 alphanumeric
 characters or hyphens. 
Example: mysubnetgroup


cacheSubnetGroupDescription
String cacheSubnetGroupDescription
A description for the cache subnet group.


subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
A list of VPC subnet IDs for the cache subnet group.








Class com.amazonaws.services.elasticache.model.CreateReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


replicationGroupId
String replicationGroupId
The replication group identifier. This parameter is stored as a
 lowercase string. Constraints: 
 A name must contain from 1
 to 20 alphanumeric characters or hyphens.
 The first character
 must be a letter.
 A name cannot end with a hyphen or contain
 two consecutive hyphens.
 


replicationGroupDescription
String replicationGroupDescription
A user-created description for the replication group.


primaryClusterId
String primaryClusterId
The identifier of the cache cluster that will serve as the primary for
 this replication group. This cache cluster must already exist and have
 a status of available. This parameter is not required if
 NumCacheClusters is specified.


automaticFailoverEnabled
Boolean automaticFailoverEnabled
Specifies whether a read-only replica will be automatically promoted
 to read/write primary if the existing primary fails. 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: 
 Redis versions earlier than 2.8.6.
 T1 and T2 cache node types.
 
 


numCacheClusters
Integer numCacheClusters
The number of cache clusters this replication group will initially
 have. 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.


preferredCacheClusterAZs
com.amazonaws.internal.ListWithAutoConstructFlag<T> preferredCacheClusterAZs
A list of EC2 availability zones in which the replication group's
 cache clusters will be created. The order of the availability zones in
 the list is not important. If you are creating your replication
 group in an Amazon VPC (recommended), you can only locate cache
 clusters in availability zones associated with the subnets in the
 selected subnet group. 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


cacheNodeType
String cacheNodeType
The compute and memory capacity of the nodes in the node group.
 Valid node types are as follows: 
 General purpose: 
 Current generation: cache.t2.micro,
 cache.t2.small, cache.t2.medium,
 cache.m3.medium, cache.m3.large,
 cache.m3.xlarge, cache.m3.2xlarge
 Previous generation: cache.t1.micro,
 cache.m1.small, cache.m1.medium,
 cache.m1.large, cache.m1.xlarge
 
 Compute optimized: cache.c1.xlarge
 Memory optimized  Current generation:
 cache.r3.large, cache.r3.xlarge,
 cache.r3.2xlarge, cache.r3.4xlarge,
 cache.r3.8xlarge
 Previous generation:
 cache.m2.xlarge, cache.m2.2xlarge,
 cache.m2.4xlarge
 
 
 Notes:
 
 All t2 instances are created in an Amazon Virtual Private
 Cloud (VPC).
 Redis backup/restore is not supported for t2
 instances.
 Redis Append-only files (AOF) functionality is not
 supported for t1 or t2 instances.
 
 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.


engine
String engine
The name of the cache engine to be used for the cache clusters in this
 replication group. Default: redis


engineVersion
String engineVersion
The version number of the cache engine to be used for the cache
 clusters in this replication group. To view the supported cache engine
 versions, use the DescribeCacheEngineVersions action.
 Important: You can upgrade to a newer engine version (see Selecting
 a Cache Engine and Version), but you cannot downgrade to an
 earlier engine version. If you want to use an earlier engine version,
 you must delete the existing cache cluster or replication group and
 create it anew with the earlier engine version.


cacheParameterGroupName
String cacheParameterGroupName
The name of the parameter group to associate with this replication
 group. If this argument is omitted, the default cache parameter group
 for the specified engine is used.


cacheSubnetGroupName
String cacheSubnetGroupName
The name of the cache subnet group to be used for the replication
 group.


cacheSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
A list of cache security group names to associate with this
 replication group.


securityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
One or more Amazon VPC security groups associated with this
 replication group. Use this parameter only when you are creating a
 replication group in an Amazon Virtual Private Cloud (VPC).


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of cost allocation tags to be added to this resource. A tag is
 a key-value pair. A tag key must be accompanied by a tag value.


snapshotArns
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshotArns
A single-element string list containing an Amazon Resource Name (ARN)
 that uniquely identifies a Redis RDB snapshot file stored in Amazon
 S3. The snapshot file will be used to populate the node group. The
 Amazon S3 object name in the ARN cannot contain any commas.
 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


snapshotName
String snapshotName
The name of a snapshot from which to restore data into the new node
 group. The snapshot status changes to restoring while the
 new node group is being created. Note: This parameter is
 only valid if the Engine parameter is redis.


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
 cluster is performed. It is specified as a range in the format
 ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
 window is a 60 minute period. Valid values for ddd are:
  sun
 mon
 tue
 wed
 thu
 fri
 sat
 
 Example:
 sun:05:00-sun:09:00


port
Integer port
The port number on which each member of the replication group will
 accept connections.


notificationTopicArn
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon Simple Notification
 Service (SNS) topic to which notifications will be sent. The
 Amazon SNS topic owner must be the same as the cache cluster
 owner.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.


snapshotRetentionLimit
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic
 snapshots before deleting them. For example, if you set
 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).


snapshotWindow
String snapshotWindow
The daily time range (in UTC) during which ElastiCache will begin
 taking a daily snapshot of your node group. 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.








Class com.amazonaws.services.elasticache.model.CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The identifier of an existing cache cluster. The snapshot will be
 created from this cache cluster.


snapshotName
String snapshotName
A name for the snapshot being created.








Class com.amazonaws.services.elasticache.model.DeleteCacheClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The cache cluster identifier for the cluster to be deleted. This
 parameter is not case sensitive.


finalSnapshotIdentifier
String finalSnapshotIdentifier
The user-supplied name of a final cache cluster snapshot. This is the
 unique name that identifies the snapshot. ElastiCache creates the
 snapshot, and then deletes the cache cluster immediately afterward.








Class com.amazonaws.services.elasticache.model.DeleteCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group to delete. The specified
 cache security group must not be associated with any cache
 clusters.








Class com.amazonaws.services.elasticache.model.DeleteCacheSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName
The name of the cache security group to delete. You cannot
 delete the default security group.








Class com.amazonaws.services.elasticache.model.DeleteCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName
The name of the cache subnet group to delete. Constraints: Must
 contain no more than 255 alphanumeric characters or hyphens.








Class com.amazonaws.services.elasticache.model.DeleteReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


replicationGroupId
String replicationGroupId
The identifier for the cluster to be deleted. This parameter is not
 case sensitive.


retainPrimaryCluster
Boolean retainPrimaryCluster
If set to true, all of the read replicas will be deleted, but
 the primary node will be retained.


finalSnapshotIdentifier
String finalSnapshotIdentifier
The name of a final node group snapshot. ElastiCache creates the
 snapshot from the primary node in the cluster, rather than one of the
 replicas; this is to ensure that it captures the freshest data. After
 the final snapshot is taken, the cluster is immediately deleted.








Class com.amazonaws.services.elasticache.model.DeleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


snapshotName
String snapshotName
The name of the snapshot to be deleted.








Class com.amazonaws.services.elasticache.model.DescribeCacheClustersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The user-supplied cluster identifier. If this parameter is specified,
 only information about that specific cache cluster is returned. This
 parameter isn't case sensitive.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.


showCacheNodeInfo
Boolean showCacheNodeInfo
An optional flag that can be included in the DescribeCacheCluster
 request to retrieve information about the individual cache nodes.








Class com.amazonaws.services.elasticache.model.DescribeCacheClustersResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


cacheClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheClusters
A list of cache clusters. Each item in the list contains detailed
 information about one cache cluster.








Class com.amazonaws.services.elasticache.model.DescribeCacheEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


engine
String engine
The cache engine to return. Valid values: memcached |
 redis


engineVersion
String engineVersion
The cache engine version to return. Example: 1.4.14


cacheParameterGroupFamily
String cacheParameterGroupFamily
The name of a specific cache parameter group family to return details
 for. Constraints: 
 Must be 1 to 255 alphanumeric
 characters
 First character must be a letter
 Cannot
 end with a hyphen or contain two consecutive hyphens
 


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.


defaultOnly
Boolean defaultOnly
If true, specifies that only the default version of the
 specified engine or engine and major version combination is to be
 returned.








Class com.amazonaws.services.elasticache.model.DescribeCacheEngineVersionsResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


cacheEngineVersions
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheEngineVersions
A list of cache engine version details. Each element in the list
 contains detailed information about one cache engine version.








Class com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of a specific cache parameter group to return details for.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


cacheParameterGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheParameterGroups
A list of cache parameter groups. Each element in the list contains
 detailed information about one cache parameter group.








Class com.amazonaws.services.elasticache.model.DescribeCacheParametersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of a specific cache parameter group to return details for.


source
String source
The parameter types to return. Valid values: user |
 system | engine-default


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeCacheParametersResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
A list of Parameter instances.


cacheNodeTypeSpecificParameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
A list of parameters specific to a particular cache node type. Each
 element in the list contains detailed information about one parameter.








Class com.amazonaws.services.elasticache.model.DescribeCacheSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName
The name of the cache security group to return details for.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeCacheSecurityGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


cacheSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroups
A list of cache security groups. Each element in the list contains
 detailed information about one group.








Class com.amazonaws.services.elasticache.model.DescribeCacheSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName
The name of the cache subnet group to return details for.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeCacheSubnetGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


cacheSubnetGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSubnetGroups
A list of cache subnet groups. Each element in the list contains
 detailed information about one group.








Class com.amazonaws.services.elasticache.model.DescribeEngineDefaultParametersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheParameterGroupFamily
String cacheParameterGroupFamily
The name of the cache parameter group family. Valid values are:
 memcached1.4 | redis2.6 |
 redis2.8


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceIdentifier
String sourceIdentifier
The identifier of the event source for which events will be returned.
 If not specified, then all sources are included in the response.


sourceType
String sourceType
The event source to retrieve events for. If no value is specified, all
 events are returned. 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


startTime
Date startTime
The beginning of the time interval to retrieve events for, specified
 in ISO 8601 format.


endTime
Date endTime
The end of the time interval for which to retrieve events, specified
 in ISO 8601 format.


duration
Integer duration
The number of minutes' worth of events to retrieve.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeEventsResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


events
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
A list of events. Each element in the list contains detailed
 information about one event.








Class com.amazonaws.services.elasticache.model.DescribeReplicationGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


replicationGroupId
String replicationGroupId
The identifier for the replication group to be described. This
 parameter is not case sensitive. If you do not specify this
 parameter, information about all replication groups is returned.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeReplicationGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


replicationGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> replicationGroups
A list of replication groups. Each item in the list contains detailed
 information about one replication group.








Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId
The offering identifier filter value. Use this parameter to show only
 the available offering that matches the specified reservation
 identifier. Example:
 438012d3-4052-4cc7-b2e3-8d3372e0e706


cacheNodeType
String cacheNodeType
The cache node type filter value. Use this parameter to show only the
 available offerings matching the specified cache node type. Valid
 node types are as follows: 
 General purpose:  Current
 generation: cache.t2.micro, cache.t2.small,
 cache.t2.medium, cache.m3.medium,
 cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 Previous generation:
 cache.t1.micro, cache.m1.small,
 cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 Compute optimized:
 cache.c1.xlarge
 Memory optimized 
 Current generation: cache.r3.large,
 cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 Previous generation: cache.m2.xlarge,
 cache.m2.2xlarge, cache.m2.4xlarge
 
 
 Notes: 
 All t2 instances are
 created in an Amazon Virtual Private Cloud (VPC).
 Redis
 backup/restore is not supported for t2 instances.
 Redis
 Append-only files (AOF) functionality is not supported for t1 or t2
 instances.
 
 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.


duration
String duration
Duration filter value, specified in years or seconds. Use this
 parameter to show only reservations for a given duration. Valid
 Values: 1 | 3 | 31536000 | 94608000


productDescription
String productDescription
The product description filter value. Use this parameter to show only
 the available offerings matching the specified product description.


offeringType
String offeringType
The offering type filter value. Use this parameter to show only the
 available offerings matching the specified offering type. Valid
 Values: "Light Utilization"|"Medium Utilization"|"Heavy
 Utilization"


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


reservedCacheNodesOfferings
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodesOfferings
A list of reserved cache node offerings. Each element in the list
 contains detailed information about one offering.








Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


reservedCacheNodeId
String reservedCacheNodeId
The reserved cache node identifier filter value. Use this parameter to
 show only the reservation that matches the specified reservation ID.


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId
The offering identifier filter value. Use this parameter to show only
 purchased reservations matching the specified offering identifier.


cacheNodeType
String cacheNodeType
The cache node type filter value. Use this parameter to show only
 those reservations matching the specified cache node type. Valid
 node types are as follows: 
 General purpose:  Current
 generation: cache.t2.micro, cache.t2.small,
 cache.t2.medium, cache.m3.medium,
 cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 Previous generation:
 cache.t1.micro, cache.m1.small,
 cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 Compute optimized:
 cache.c1.xlarge
 Memory optimized 
 Current generation: cache.r3.large,
 cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 Previous generation: cache.m2.xlarge,
 cache.m2.2xlarge, cache.m2.4xlarge
 
 
 Notes: 
 All t2 instances are
 created in an Amazon Virtual Private Cloud (VPC).
 Redis
 backup/restore is not supported for t2 instances.
 Redis
 Append-only files (AOF) functionality is not supported for t1 or t2
 instances.
 
 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.


duration
String duration
The duration filter value, specified in years or seconds. Use this
 parameter to show only reservations for this duration. Valid
 Values: 1 | 3 | 31536000 | 94608000


productDescription
String productDescription
The product description filter value. Use this parameter to show only
 those reservations matching the specified product description.


offeringType
String offeringType
The offering type filter value. Use this parameter to show only the
 available offerings matching the specified offering type. Valid
 values: "Light Utilization"|"Medium Utilization"|"Heavy
 Utilization"


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 100 
Constraints: minimum 20; maximum 100.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesResult extends Object implements Serializable




Serialized Fields


marker
String marker
Provides an identifier to allow retrieval of paginated results.


reservedCacheNodes
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedCacheNodes
A list of reserved cache nodes. Each element in the list contains
 detailed information about one node.








Class com.amazonaws.services.elasticache.model.DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
A user-supplied cluster identifier. If this parameter is specified,
 only snapshots associated with that specific cache cluster will be
 described.


snapshotName
String snapshotName
A user-supplied name of the snapshot. If this parameter is specified,
 only this snapshot will be described.


snapshotSource
String snapshotSource
If set to 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.


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a
 marker is included in the response so that the remaining results can
 be retrieved. Default: 50 
Constraints: minimum 20; maximum 50.








Class com.amazonaws.services.elasticache.model.DescribeSnapshotsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional marker returned from a prior request. Use this marker for
 pagination of results from this action. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.


snapshots
com.amazonaws.internal.ListWithAutoConstructFlag<T> snapshots
A list of snapshots. Each item in the list contains detailed
 information about one snapshot.








Class com.amazonaws.services.elasticache.model.EC2SecurityGroup extends Object implements Serializable




Serialized Fields


status
String status
The status of the Amazon EC2 security group.


eC2SecurityGroupName
String eC2SecurityGroupName
The name of the Amazon EC2 security group.


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId
The AWS account ID of the Amazon EC2 security group owner.








Class com.amazonaws.services.elasticache.model.Endpoint extends Object implements Serializable




Serialized Fields


address
String address
The DNS hostname of the cache node.


port
Integer port
The port number that the cache engine is listening on.








Class com.amazonaws.services.elasticache.model.EngineDefaults extends Object implements Serializable




Serialized Fields


cacheParameterGroupFamily
String cacheParameterGroupFamily
Specifies the name of the cache parameter group family to which the
 engine default parameters apply.


marker
String marker
Provides an identifier to allow retrieval of paginated results.


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Contains a list of engine default parameters.


cacheNodeTypeSpecificParameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeTypeSpecificParameters
A list of parameters specific to a particular cache node type. Each
 element in the list contains detailed information about one parameter.








Class com.amazonaws.services.elasticache.model.Event extends Object implements Serializable




Serialized Fields


sourceIdentifier
String sourceIdentifier
The identifier for the source of the event. For example, if the event
 occurred at the cache cluster level, the identifier would be the name
 of the cache cluster.


sourceType
String sourceType
Specifies the origin of this event - a cache cluster, a parameter
 group, a security group, etc.
 
 Constraints:

 Allowed Values: cache-cluster, cache-parameter-group, cache-security-group, cache-subnet-group


message
String message
The text of the event.


date
Date date
The date and time when the event occurred.








Class com.amazonaws.services.elasticache.model.InsufficientCacheClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidARNException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidCacheClusterStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidCacheParameterGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidCacheSecurityGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidParameterCombinationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidReplicationGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ListAllowedNodeTypeModificationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The name of the cache cluster you want to scale up to a larger node
 instanced type. ElastiCache uses the cluster id to identify the
 current node type of this cluster and from that to to create a list of
 node types you can scale up to. Important:
 You must
 provide a value for either the CacheClusterId or the
 ReplicationGroupId.


replicationGroupId
String replicationGroupId
The name of the replication group want to scale up to a larger node
 type. ElastiCache uses the replication group id to identify the
 current node type being used by this replication group, and from that
 to create a list of node types you can scale up to.
 Important:
 You must provide a value for either the
 CacheClusterId or the ReplicationGroupId.








Class com.amazonaws.services.elasticache.model.ListAllowedNodeTypeModificationsResult extends Object implements Serializable




Serialized Fields


scaleUpModifications
com.amazonaws.internal.ListWithAutoConstructFlag<T> scaleUpModifications
A string list, each element of which specifies a cache node type which
 you can use to scale your cache cluster or replication group. When
 scaling up a Redis cluster or replication group using
 ModifyCacheCluster or
 ModifyReplicationGroup, use a value from this list for
 the CacheNodeType parameter.








Class com.amazonaws.services.elasticache.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceName
String resourceName
The Amazon Resource Name (ARN) of the resource for which you want the
 list of tags, for example
 arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
 or
 arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
 For more information on ARNs, go to Amazon
 Resource Names (ARNs) and AWS Service Namespaces.








Class com.amazonaws.services.elasticache.model.ListTagsForResourceResult extends Object implements Serializable




Serialized Fields


tagList
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
A list of cost allocation tags as key-value pairs.








Class com.amazonaws.services.elasticache.model.ModifyCacheClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The cache cluster identifier. This value is stored as a lowercase
 string.


numCacheNodes
Integer numCacheNodes
The number of cache nodes that the cache cluster should have. If the
 value for 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.


cacheNodeIdsToRemove
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
A list of cache node IDs to be removed. A node ID is a numeric
 identifier (0001, 0002, etc.). This parameter is only valid when
 NumCacheNodes is less than the existing number of cache nodes.
 The number of cache node IDs supplied in this parameter must match the
 difference between the existing number of cache nodes in the cluster
 or pending cache nodes, whichever is greater, and the value of
 NumCacheNodes in the request. 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.


aZMode
String aZMode
Specifies whether the new nodes in this Memcached cache cluster are
 all created in a single Availability Zone or created across multiple
 Availability Zones. Valid values: single-az |
 cross-az. 
This option is only supported for Memcached
 cache clusters. 
You cannot specify 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. 
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. 
 

 Constraints:

 Allowed Values: single-az, cross-az


newAvailabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> newAvailabilityZones
The list of Availability Zones where the new Memcached cache nodes
 will be created. 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: 
 Scenario 1: You have 3 active nodes and
 wish to add 2 nodes.
 Specify NumCacheNodes=5 (3 + 2)
 and optionally specify two Availability Zones for the two new
 nodes.
 Scenario 2: You have 3 active nodes and 2 nodes
 pending creation (from the scenario 1 call) and want to add 1 more
 node.
 Specify NumCacheNodes=6 ((3 + 2) + 1) and
 optionally specify an Availability Zone for the new node.
 Scenario 3: You want to cancel all pending actions.

 Specify 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 
 Scenario-1 
 Pending Action: Delete
 New Request: Delete
 Result: The new delete, pending or immediate, replaces the pending
 delete.
 
 Scenario-2  Pending Action:
 Delete
 New Request: Create
 Result: The new create,
 pending or immediate, replaces the pending delete.
 
 Scenario-3  Pending Action: Create
 New Request:
 Delete
 Result: The new delete, pending or immediate, replaces
 the pending create.
 
 Scenario-4  Pending
 Action: Create
 New Request: Create
 Result: 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


cacheSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
A list of cache security group names to authorize on this cache
 cluster. This change is asynchronously applied as soon as possible.
 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".


securityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Specifies the VPC Security Groups associated with the cache cluster.
 This parameter can be used only with clusters that are created in
 an Amazon Virtual Private Cloud (VPC).


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
 cluster is performed. It is specified as a range in the format
 ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
 window is a 60 minute period. Valid values for ddd are:
  sun
 mon
 tue
 wed
 thu
 fri
 sat
 
 Example:
 sun:05:00-sun:09:00


notificationTopicArn
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
 notifications will be sent. The Amazon SNS topic owner must be
 same as the cache cluster owner. 


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group to apply to this cache cluster.
 This change is asynchronously applied as soon as possible for
 parameters when the ApplyImmediately parameter is specified as
 true for this request.


notificationTopicStatus
String notificationTopicStatus
The status of the Amazon SNS notification topic. Notifications are
 sent only if the status is active. Valid values:
 active | inactive


applyImmediately
Boolean applyImmediately
If 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. If you perform a
 ModifyCacheCluster before a pending modification is
 applied, the pending modification is replaced by the newer
 modification. 
Valid values: true |
 false 
Default: false


engineVersion
String engineVersion
The upgraded version of the cache engine to be run on the cache nodes.
 Important: You can upgrade to a newer engine version (see Selecting
 a Cache Engine and Version), but you cannot downgrade to an
 earlier engine version. If you want to use an earlier engine version,
 you must delete the existing cache cluster and create it anew with the
 earlier engine version.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.


snapshotRetentionLimit
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic cache
 cluster snapshots before deleting them. For example, if you set
 SnapshotRetentionLimit to 5, then a snapshot that was taken
 today will be retained for 5 days before being deleted.
 Important
If the value of SnapshotRetentionLimit is set
 to zero (0), backups are turned off.


snapshotWindow
String snapshotWindow
The daily time range (in UTC) during which ElastiCache will begin
 taking a daily snapshot of your cache cluster.


cacheNodeType
String cacheNodeType
A valid cache node type that you want to scale this cache cluster to.
 The value of this parameter must be one of the
 ScaleUpModifications values returned by the
 ListAllowedCacheNodeTypeModification action.








Class com.amazonaws.services.elasticache.model.ModifyCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group to modify.


parameterNameValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
An array of parameter names and values for the parameter update. You
 must supply at least one parameter name and value; subsequent
 arguments are optional. A maximum of 20 parameters may be modified per
 request.








Class com.amazonaws.services.elasticache.model.ModifyCacheParameterGroupResult extends Object implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group.








Class com.amazonaws.services.elasticache.model.ModifyCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSubnetGroupName
String cacheSubnetGroupName
The name for the cache subnet group. This value is stored as a
 lowercase string. Constraints: Must contain no more than 255
 alphanumeric characters or hyphens. 
Example:
 mysubnetgroup


cacheSubnetGroupDescription
String cacheSubnetGroupDescription
A description for the cache subnet group.


subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
The EC2 subnet IDs for the cache subnet group.








Class com.amazonaws.services.elasticache.model.ModifyReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


replicationGroupId
String replicationGroupId
The identifier of the replication group to modify.


replicationGroupDescription
String replicationGroupDescription
A description for the replication group. Maximum length is 255
 characters.


primaryClusterId
String primaryClusterId
If this parameter is specified, ElastiCache will promote the specified
 cluster in the specified replication group to the primary role. The
 nodes of all other clusters in the replication group will be read
 replicas.


snapshottingClusterId
String snapshottingClusterId
The cache cluster ID that will be used as the daily snapshot source
 for the replication group.


automaticFailoverEnabled
Boolean automaticFailoverEnabled
Whether a read replica will be automatically promoted to read/write
 primary if the existing primary encounters a failure. Valid values:
 true | false 
ElastiCache Multi-AZ
 replication groups are not supported on: 
 Redis versions
 earlier than 2.8.6.
 T1 and T2 cache node types.
 
 


cacheSecurityGroupNames
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheSecurityGroupNames
A list of cache security group names to authorize for the clusters in
 this replication group. This change is asynchronously applied as soon
 as possible. 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".


securityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
Specifies the VPC Security Groups associated with the cache clusters
 in the replication group. This parameter can be used only with
 replication group containing cache clusters running in an Amazon
 Virtual Private Cloud (VPC).


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
 cluster is performed. It is specified as a range in the format
 ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
 window is a 60 minute period. Valid values for ddd are:
  sun
 mon
 tue
 wed
 thu
 fri
 sat
 
 Example:
 sun:05:00-sun:09:00


notificationTopicArn
String notificationTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic to which
 notifications will be sent. The Amazon SNS topic owner must be
 same as the replication group owner. 


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group to apply to all of the clusters
 in this replication group. This change is asynchronously applied as
 soon as possible for parameters when the ApplyImmediately
 parameter is specified as true for this request.


notificationTopicStatus
String notificationTopicStatus
The status of the Amazon SNS notification topic for the replication
 group. Notifications are sent only if the status is active.
 Valid values: active | inactive


applyImmediately
Boolean applyImmediately
If 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


engineVersion
String engineVersion
The upgraded version of the cache engine to be run on the cache
 clusters in the replication group. Important: You can
 upgrade to a newer engine version (see Selecting
 a Cache Engine and Version), but you cannot downgrade to an
 earlier engine version. If you want to use an earlier engine version,
 you must delete the existing replication group and create it anew with
 the earlier engine version.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.


snapshotRetentionLimit
Integer snapshotRetentionLimit
The number of days for which ElastiCache will retain automatic node
 group snapshots before deleting them. For example, if you set
 SnapshotRetentionLimit to 5, then a snapshot that was taken
 today will be retained for 5 days before being deleted.
 Important
If the value of SnapshotRetentionLimit is set
 to zero (0), backups are turned off.


snapshotWindow
String snapshotWindow
The daily time range (in UTC) during which ElastiCache will begin
 taking a daily snapshot of the node group specified by
 SnapshottingClusterId. Example: 05:00-09:00
 
If you do not specify this parameter, then ElastiCache will
 automatically choose an appropriate time range.


cacheNodeType
String cacheNodeType
A valid cache node type that you want to scale this replication group
 to. The value of this parameter must be one of the
 ScaleUpModifications values returned by the
 ListAllowedCacheNodeTypeModification action.








Class com.amazonaws.services.elasticache.model.NodeGroup extends Object implements Serializable




Serialized Fields


nodeGroupId
String nodeGroupId
The identifier for the node group. A replication group contains only
 one node group; therefore, the node group ID is 0001.


status
String status
The current state of this replication group - creating,
 available, etc.


primaryEndpoint
Endpoint primaryEndpoint
Represents the information required for client programs to connect to
 a cache node.


nodeGroupMembers
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroupMembers
A list containing information about individual nodes within the node
 group.








Class com.amazonaws.services.elasticache.model.NodeGroupMember extends Object implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The ID of the cache cluster to which the node belongs.


cacheNodeId
String cacheNodeId
The ID of the node within its cache cluster. A node ID is a numeric
 identifier (0001, 0002, etc.).


readEndpoint
Endpoint readEndpoint
Represents the information required for client programs to connect to
 a cache node.


preferredAvailabilityZone
String preferredAvailabilityZone
The name of the Availability Zone in which the node is located.


currentRole
String currentRole
The role that is currently assigned to the node - primary or
 replica.








Class com.amazonaws.services.elasticache.model.NodeQuotaForClusterExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.NodeQuotaForCustomerExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.NodeSnapshot extends Object implements Serializable




Serialized Fields


cacheNodeId
String cacheNodeId
The cache node identifier for the node in the source cache cluster.


cacheSize
String cacheSize
The size of the cache on the source cache node.


cacheNodeCreateTime
Date cacheNodeCreateTime
The date and time when the cache node was created in the source cache
 cluster.


snapshotCreateTime
Date snapshotCreateTime
The date and time when the source node's metadata and cache data set
 was obtained for the snapshot.








Class com.amazonaws.services.elasticache.model.NotificationConfiguration extends Object implements Serializable




Serialized Fields


topicArn
String topicArn
The Amazon Resource Name (ARN) that identifies the topic.


topicStatus
String topicStatus
The current state of the topic.








Class com.amazonaws.services.elasticache.model.Parameter extends Object implements Serializable




Serialized Fields


parameterName
String parameterName
The name of the parameter.


parameterValue
String parameterValue
The value of the parameter.


description
String description
A description of the parameter.


source
String source
The source of the parameter.


dataType
String dataType
The valid data type for the parameter.


allowedValues
String allowedValues
The valid range of values for the parameter.


isModifiable
Boolean isModifiable
Indicates whether (true) or not (false) the
 parameter can be modified. Some parameters have security or
 operational implications that prevent them from being changed.


minimumEngineVersion
String minimumEngineVersion
The earliest cache engine version to which the parameter can apply.








Class com.amazonaws.services.elasticache.model.ParameterNameValue extends Object implements Serializable




Serialized Fields


parameterName
String parameterName
The name of the parameter.


parameterValue
String parameterValue
The value of the parameter.








Class com.amazonaws.services.elasticache.model.PendingModifiedValues extends Object implements Serializable




Serialized Fields


numCacheNodes
Integer numCacheNodes
The new number of cache nodes for the cache cluster. For clusters
 running Redis, this value must be 1. For clusters running Memcached,
 this value must be between 1 and 20.


cacheNodeIdsToRemove
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToRemove
A list of cache node IDs that are being removed (or will be removed)
 from the cache cluster. A node ID is a numeric identifier (0001, 0002,
 etc.).


engineVersion
String engineVersion
The new cache engine version that the cache cluster will run.


cacheNodeType
String cacheNodeType
The cache node type that this cache cluster or replication group will
 be scaled to.








Class com.amazonaws.services.elasticache.model.PurchaseReservedCacheNodesOfferingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId
The ID of the reserved cache node offering to purchase. Example:
 438012d3-4052-4cc7-b2e3-8d3372e0e706


reservedCacheNodeId
String reservedCacheNodeId
A customer-specified identifier to track this reservation.
 Note:
The Reserved Cache Node ID is an unique
 customer-specified identifier to track this reservation. If this
 parameter is not specified, ElastiCache automatically generates an
 identifier for the reservation. 
Example: myreservationID


cacheNodeCount
Integer cacheNodeCount
The number of cache node instances to reserve. Default:
 1








Class com.amazonaws.services.elasticache.model.RebootCacheClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheClusterId
String cacheClusterId
The cache cluster identifier. This parameter is stored as a lowercase
 string.


cacheNodeIdsToReboot
com.amazonaws.internal.ListWithAutoConstructFlag<T> cacheNodeIdsToReboot
A list of cache node IDs to reboot. A node ID is a numeric identifier
 (0001, 0002, etc.). To reboot an entire cache cluster, specify all of
 the cache node IDs.








Class com.amazonaws.services.elasticache.model.RecurringCharge extends Object implements Serializable




Serialized Fields


recurringChargeAmount
Double recurringChargeAmount
The monetary amount of the recurring charge.


recurringChargeFrequency
String recurringChargeFrequency
The frequency of the recurring charge.








Class com.amazonaws.services.elasticache.model.RemoveTagsFromResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceName
String resourceName
The Amazon Resource Name (ARN) of the resource from which you want the
 tags removed, for example
 arn:aws:elasticache:us-west-2:0123456789:cluster:myCluster
 or
 arn:aws:elasticache:us-west-2:0123456789:snapshot:mySnapshot.
 For more information on ARNs, go to Amazon
 Resource Names (ARNs) and AWS Service Namespaces.


tagKeys
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
A list of 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.








Class com.amazonaws.services.elasticache.model.RemoveTagsFromResourceResult extends Object implements Serializable




Serialized Fields


tagList
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
A list of cost allocation tags as key-value pairs.








Class com.amazonaws.services.elasticache.model.ReplicationGroup extends Object implements Serializable




Serialized Fields


replicationGroupId
String replicationGroupId
The identifier for the replication group.


description
String description
The description of the replication group.


status
String status
The current state of this replication group - creating,
 available, etc.


pendingModifiedValues
ReplicationGroupPendingModifiedValues pendingModifiedValues
A group of settings to be applied to the replication group, either
 immediately or during the next maintenance window.


memberClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> memberClusters
The names of all the cache clusters that are part of this replication
 group.


nodeGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeGroups
A single element list with information about the nodes in the
 replication group.


snapshottingClusterId
String snapshottingClusterId
The cache cluster ID that is used as the daily snapshot source for the
 replication group.


automaticFailover
String automaticFailover
Indicates the status of Multi-AZ for this replication group.
 ElastiCache Multi-AZ replication groups are not supported on:
 
 Redis versions earlier than 2.8.6.
 T1 and T2 cache
 node types.
 
 
 
 Constraints:

 Allowed Values: enabled, disabled, enabling, disabling








Class com.amazonaws.services.elasticache.model.ReplicationGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReplicationGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReplicationGroupPendingModifiedValues extends Object implements Serializable




Serialized Fields


primaryClusterId
String primaryClusterId
The primary cluster ID which will be applied immediately (if
 --apply-immediately was specified), or during the next
 maintenance window.


automaticFailoverStatus
String automaticFailoverStatus
Indicates the status of Multi-AZ for this replication group.
 ElastiCache Multi-AZ replication groups are not supported on:
 
 Redis versions earlier than 2.8.6.
 T1 and T2 cache
 node types.
 
 
 
 Constraints:

 Allowed Values: enabled, disabled








Class com.amazonaws.services.elasticache.model.ReservedCacheNode extends Object implements Serializable




Serialized Fields


reservedCacheNodeId
String reservedCacheNodeId
The unique identifier for the reservation.


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId
The offering identifier.


cacheNodeType
String cacheNodeType
The cache node type for the reserved cache nodes. Valid node types
 are as follows: 
 General purpose:  Current generation:
 cache.t2.micro, cache.t2.small,
 cache.t2.medium, cache.m3.medium,
 cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 Previous generation:
 cache.t1.micro, cache.m1.small,
 cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 Compute optimized:
 cache.c1.xlarge
 Memory optimized 
 Current generation: cache.r3.large,
 cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 Previous generation: cache.m2.xlarge,
 cache.m2.2xlarge, cache.m2.4xlarge
 
 
 Notes: 
 All t2 instances are
 created in an Amazon Virtual Private Cloud (VPC).
 Redis
 backup/restore is not supported for t2 instances.
 Redis
 Append-only files (AOF) functionality is not supported for t1 or t2
 instances.
 
 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.


startTime
Date startTime
The time the reservation started.


duration
Integer duration
The duration of the reservation in seconds.


fixedPrice
Double fixedPrice
The fixed price charged for this reserved cache node.


usagePrice
Double usagePrice
The hourly price charged for this reserved cache node.


cacheNodeCount
Integer cacheNodeCount
The number of cache nodes that have been reserved.


productDescription
String productDescription
The description of the reserved cache node.


offeringType
String offeringType
The offering type of this reserved cache node.


state
String state
The state of the reserved cache node.


recurringCharges
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
The recurring price charged to run this reserved cache node.








Class com.amazonaws.services.elasticache.model.ReservedCacheNodeAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReservedCacheNodeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReservedCacheNodeQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ReservedCacheNodesOffering extends Object implements Serializable




Serialized Fields


reservedCacheNodesOfferingId
String reservedCacheNodesOfferingId
A unique identifier for the reserved cache node offering.


cacheNodeType
String cacheNodeType
The cache node type for the reserved cache node. Valid node types
 are as follows: 
 General purpose:  Current generation:
 cache.t2.micro, cache.t2.small,
 cache.t2.medium, cache.m3.medium,
 cache.m3.large, cache.m3.xlarge,
 cache.m3.2xlarge
 Previous generation:
 cache.t1.micro, cache.m1.small,
 cache.m1.medium, cache.m1.large,
 cache.m1.xlarge
 
 Compute optimized:
 cache.c1.xlarge
 Memory optimized 
 Current generation: cache.r3.large,
 cache.r3.xlarge, cache.r3.2xlarge,
 cache.r3.4xlarge, cache.r3.8xlarge
 Previous generation: cache.m2.xlarge,
 cache.m2.2xlarge, cache.m2.4xlarge
 
 
 Notes: 
 All t2 instances are
 created in an Amazon Virtual Private Cloud (VPC).
 Redis
 backup/restore is not supported for t2 instances.
 Redis
 Append-only files (AOF) functionality is not supported for t1 or t2
 instances.
 
 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.


duration
Integer duration
The duration of the offering. in seconds.


fixedPrice
Double fixedPrice
The fixed price charged for this offering.


usagePrice
Double usagePrice
The hourly price charged for this offering.


productDescription
String productDescription
The cache engine used by the offering.


offeringType
String offeringType
The offering type.


recurringCharges
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
The recurring price charged to run this reserved cache node.








Class com.amazonaws.services.elasticache.model.ReservedCacheNodesOfferingNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.ResetCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group to reset.


resetAllParameters
Boolean resetAllParameters
If true, all parameters in the cache parameter group will be
 reset to default values. If false, no such action occurs.
 Valid values: true | false


parameterNameValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameterNameValues
An array of parameter names to be reset. If you are not resetting the
 entire cache parameter group, you must specify at least one parameter
 name.








Class com.amazonaws.services.elasticache.model.ResetCacheParameterGroupResult extends Object implements Serializable




Serialized Fields


cacheParameterGroupName
String cacheParameterGroupName
The name of the cache parameter group.








Class com.amazonaws.services.elasticache.model.RevokeCacheSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cacheSecurityGroupName
String cacheSecurityGroupName
The name of the cache security group to revoke ingress from.


eC2SecurityGroupName
String eC2SecurityGroupName
The name of the Amazon EC2 security group to revoke access from.


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId
The AWS account number of the Amazon EC2 security group owner. Note
 that this is not the same thing as an AWS access key ID - you must
 provide a valid AWS account number for this parameter.








Class com.amazonaws.services.elasticache.model.SecurityGroupMembership extends Object implements Serializable




Serialized Fields


securityGroupId
String securityGroupId
The identifier of the cache security group.


status
String status
The status of the cache security group membership. The status changes
 whenever a cache security group is modified, or when the cache
 security groups assigned to a cache cluster are modified.








Class com.amazonaws.services.elasticache.model.Snapshot extends Object implements Serializable




Serialized Fields


snapshotName
String snapshotName
The name of a snapshot. For an automatic snapshot, the name is
 system-generated; for a manual snapshot, this is the user-provided
 name.


cacheClusterId
String cacheClusterId
The user-supplied identifier of the source cache cluster.


snapshotStatus
String snapshotStatus
The status of the snapshot. Valid values: creating |
 available | restoring | copying
 | deleting.


snapshotSource
String snapshotSource
Indicates whether the snapshot is from an automatic backup
 (automated) or was created manually
 (manual).


cacheNodeType
String cacheNodeType
The name of the compute and memory capacity node type for the source
 cache cluster. Valid node types are as follows: 
 General
 purpose:  Current generation: cache.t2.micro,
 cache.t2.small, cache.t2.medium,
 cache.m3.medium, cache.m3.large,
 cache.m3.xlarge, cache.m3.2xlarge
 Previous generation: cache.t1.micro,
 cache.m1.small, cache.m1.medium,
 cache.m1.large, cache.m1.xlarge
 
 Compute optimized: cache.c1.xlarge
 Memory optimized  Current generation:
 cache.r3.large, cache.r3.xlarge,
 cache.r3.2xlarge, cache.r3.4xlarge,
 cache.r3.8xlarge
 Previous generation:
 cache.m2.xlarge, cache.m2.2xlarge,
 cache.m2.4xlarge
 
 
 Notes:
 
 All t2 instances are created in an Amazon Virtual Private
 Cloud (VPC).
 Redis backup/restore is not supported for t2
 instances.
 Redis Append-only files (AOF) functionality is not
 supported for t1 or t2 instances.
 
 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.


engine
String engine
The name of the cache engine (memcached or redis) used
 by the source cache cluster.


engineVersion
String engineVersion
The version of the cache engine version that is used by the source
 cache cluster.


numCacheNodes
Integer numCacheNodes
The number of cache nodes in the source cache cluster. For clusters
 running Redis, this value must be 1. For clusters running Memcached,
 this value must be between 1 and 20.


preferredAvailabilityZone
String preferredAvailabilityZone
The name of the Availability Zone in which the source cache cluster is
 located.


cacheClusterCreateTime
Date cacheClusterCreateTime
The date and time when the source cache cluster was created.


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which maintenance on the cache
 cluster is performed. It is specified as a range in the format
 ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
 window is a 60 minute period. Valid values for ddd are:
  sun
 mon
 tue
 wed
 thu
 fri
 sat
 
 Example:
 sun:05:00-sun:09:00


topicArn
String topicArn
The Amazon Resource Name (ARN) for the topic used by the source cache
 cluster for publishing notifications.


port
Integer port
The port number used by each cache nodes in the source cache cluster.


cacheParameterGroupName
String cacheParameterGroupName
The cache parameter group that is associated with the source cache
 cluster.


cacheSubnetGroupName
String cacheSubnetGroupName
The name of the cache subnet group associated with the source cache
 cluster.


vpcId
String vpcId
The Amazon Virtual Private Cloud identifier (VPC ID) of the cache
 subnet group for the source cache cluster.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
This parameter is currently disabled.


snapshotRetentionLimit
Integer snapshotRetentionLimit
For an automatic snapshot, the number of days for which ElastiCache
 will retain the snapshot before deleting it. 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.


snapshotWindow
String snapshotWindow
The daily time range during which ElastiCache takes daily snapshots of
 the source cache cluster.


nodeSnapshots
com.amazonaws.internal.ListWithAutoConstructFlag<T> nodeSnapshots
A list of the cache nodes in the source cache cluster.








Class com.amazonaws.services.elasticache.model.SnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.SnapshotFeatureNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.SnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.SnapshotQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.Subnet extends Object implements Serializable




Serialized Fields


subnetIdentifier
String subnetIdentifier
The unique identifier for the subnet.


subnetAvailabilityZone
AvailabilityZone subnetAvailabilityZone
The Availability Zone associated with the subnet.








Class com.amazonaws.services.elasticache.model.SubnetInUseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.Tag extends Object implements Serializable




Serialized Fields


key
String key
The key for the tag.


value
String value
The tag's value. May not be null.








Class com.amazonaws.services.elasticache.model.TagNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticache.model.TagQuotaPerResourceExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.elasticbeanstalk.model




Class com.amazonaws.services.elasticbeanstalk.model.AbortEnvironmentUpdateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
String environmentId

 This specifies the ID of the environment with the in-progress update that
 you want to cancel.
 


environmentName
String environmentName

 This specifies the name of the environment with the in-progress update
 that you want to cancel.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplicationDescription extends Object implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application.
 


description
String description

 User-defined description of the application.
 


dateCreated
Date dateCreated

 The date when the application was created.
 


dateUpdated
Date dateUpdated

 The date when the application was last modified.
 


versions
com.amazonaws.internal.SdkInternalList<T> versions

 The names of the versions for this application.
 


configurationTemplates
com.amazonaws.internal.SdkInternalList<T> configurationTemplates

 The names of the configuration templates associated with this
 application.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplicationMetrics extends Object implements Serializable




Serialized Fields


duration
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).
 


requestCount
Integer requestCount

 Average number of requests handled by the web server per second over the
 last 10 seconds.
 


statusCodes
StatusCodes statusCodes

 Represents the percentage of requests over the last 10 seconds that
 resulted in each type of status code response.
 


latency
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplicationVersionDescription extends Object implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application associated with this release.
 


description
String description

 The description of this application version.
 


versionLabel
String versionLabel

 A label uniquely identifying the version for the associated application.
 


sourceBundle
S3Location sourceBundle

 The location where the source bundle is located for this version.
 


dateCreated
Date dateCreated

 The creation date of the application version.
 


dateUpdated
Date dateUpdated

 The last modified date of the application version.
 


status
String status

 The processing status of the application version.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplyEnvironmentManagedActionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentName
String environmentName

 The name of the target environment.
 


environmentId
String environmentId

 The environment ID of the target environment.
 


actionId
String actionId

 The action ID of the scheduled managed action to execute.
 








Class com.amazonaws.services.elasticbeanstalk.model.ApplyEnvironmentManagedActionResult extends Object implements Serializable




Serialized Fields


actionId
String actionId

 The action ID of the managed action.
 


actionDescription
String actionDescription

 A description of the managed action.
 


actionType
String actionType

 The type of managed action.
 


status
String status

 The status of the managed action.
 








Class com.amazonaws.services.elasticbeanstalk.model.AutoScalingGroup extends Object implements Serializable




Serialized Fields


name
String name

 The name of the AutoScalingGroup .
 








Class com.amazonaws.services.elasticbeanstalk.model.CheckDNSAvailabilityRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


cNAMEPrefix
String cNAMEPrefix

 The prefix used when this CNAME is reserved.
 








Class com.amazonaws.services.elasticbeanstalk.model.CheckDNSAvailabilityResult extends Object implements Serializable




Serialized Fields


available
Boolean available

 Indicates if the specified CNAME is available:
 
 
  true : The CNAME is available.
  false : The CNAME is not available.
 


fullyQualifiedCNAME
String fullyQualifiedCNAME

 The fully qualified CNAME to reserve when CreateEnvironment is
 called with the provided prefix.
 








Class com.amazonaws.services.elasticbeanstalk.model.ComposeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application to which the specified source bundles belong.
 


groupName
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.
 


versionLabels
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.ComposeEnvironmentsResult extends Object implements Serializable




Serialized Fields


environments
com.amazonaws.internal.SdkInternalList<T> environments

 Returns an EnvironmentDescription list.
 








Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionDescription extends Object implements Serializable




Serialized Fields


namespace
String namespace

 A unique namespace identifying the option's associated AWS resource.
 


name
String name

 The name of the configuration option.
 


defaultValue
String defaultValue

 The default value for this configuration option.
 


changeSeverity
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.
 


userDefined
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
 


valueType
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.
 


valueOptions
com.amazonaws.internal.SdkInternalList<T> valueOptions

 If specified, values for the configuration option are selected from this
 list.
 


minValue
Integer minValue

 If specified, the configuration option must be a numeric value greater
 than this value.
 


maxValue
Integer maxValue

 If specified, the configuration option must be a numeric value less than
 this value.
 


maxLength
Integer maxLength

 If specified, the configuration option must be a string value no longer
 than this value.
 


regex
OptionRestrictionRegex regex

 If specified, the configuration option must be a string value that
 satisfies this regular expression.
 








Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionSetting extends Object implements Serializable




Serialized Fields


resourceName
String resourceName

 A unique resource name for a time-based scaling configuration option.
 


namespace
String namespace

 A unique namespace identifying the option's associated AWS resource.
 


optionName
String optionName

 The name of the configuration option.
 


value
String value

 The current value for the configuration option.
 








Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationSettingsDescription extends Object implements Serializable




Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack this configuration set uses.
 


applicationName
String applicationName

 The name of the application associated with this configuration set.
 


templateName
String templateName

 If not null, the name of the configuration template for this
 configuration set.
 


description
String description

 Describes this configuration set.
 


environmentName
String environmentName

 If not null, the name of the environment for this
 configuration set.
 


deploymentStatus
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.
 


dateCreated
Date dateCreated

 The date (in UTC time) when this configuration set was created.
 


dateUpdated
Date dateUpdated

 The date (in UTC time) when this configuration set was last modified.
 


optionSettings
com.amazonaws.internal.SdkInternalList<T> optionSettings

 A list of the configuration options and their values in this
 configuration set.
 








Class com.amazonaws.services.elasticbeanstalk.model.CPUUtilization extends Object implements Serializable




Serialized Fields


user
Double user

 Percentage of time that the CPU has spent in the User state
 over the last 10 seconds.
 


nice
Double nice

 Percentage of time that the CPU has spent in the Nice state
 over the last 10 seconds.
 


system
Double system

 Percentage of time that the CPU has spent in the System
 state over the last 10 seconds.
 


idle
Double idle

 Percentage of time that the CPU has spent in the Idle state
 over the last 10 seconds.
 


iOWait
Double iOWait

 Percentage of time that the CPU has spent in the I/O Wait
 state over the last 10 seconds.
 


iRQ
Double iRQ

 Percentage of time that the CPU has spent in the IRQ state
 over the last 10 seconds.
 


softIRQ
Double softIRQ

 Percentage of time that the CPU has spent in the SoftIRQ
 state over the last 10 seconds.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application.
 
 
 Constraint: This name must be unique within your account. If the
 specified name already exists, the action returns an
 InvalidParameterValue error.
 


description
String description

 Describes the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationResult extends Object implements Serializable




Serialized Fields


application
ApplicationDescription application

 The ApplicationDescription of the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application. If no application is found with this name,
 and AutoCreateApplication is false, returns an
 InvalidParameterValue error.
 


versionLabel
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.
 


description
String description

 Describes this version.
 


sourceBundle
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.
 


autoCreateApplication
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
 


process
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionResult extends Object implements Serializable




Serialized Fields


applicationVersion
ApplicationVersionDescription applicationVersion

 The ApplicationVersionDescription of the application version.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
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.
 


templateName
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.
 


solutionStackName
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 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.
 


environmentId
String environmentId

 The ID of the environment used with this configuration template.
 


description
String description

 Describes this configuration.
 


optionSettings
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateResult extends Object implements Serializable




Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack this configuration set uses.
 


applicationName
String applicationName

 The name of the application associated with this configuration set.
 


templateName
String templateName

 If not null, the name of the configuration template for this
 configuration set.
 


description
String description

 Describes this configuration set.
 


environmentName
String environmentName

 If not null, the name of the environment for this
 configuration set.
 


deploymentStatus
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.
 


dateCreated
Date dateCreated

 The date (in UTC time) when this configuration set was created.
 


dateUpdated
Date dateUpdated

 The date (in UTC time) when this configuration set was last modified.
 


optionSettings
com.amazonaws.internal.SdkInternalList<T> optionSettings

 A list of the configuration options and their values in this
 configuration set.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
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.
 


environmentName
String environmentName

 A unique name for the deployment environment. Used in the application
 URL.
 
 
 Constraint: Must be from 4 to 40 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.
 


groupName
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.
 


description
String description

 Describes this environment.
 


cNAMEPrefix
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.
 


tier
EnvironmentTier tier

 This specifies the tier to use for creating this environment.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 This specifies the tags applied to resources in the environment.
 


versionLabel
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.
 


templateName
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.
 


solutionStackName
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.
 


optionSettings
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.
 


optionsToRemove
com.amazonaws.internal.SdkInternalList<T> optionsToRemove

 A list of custom user-defined configuration options to remove from the
 configuration set for this new environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentResult extends Object implements Serializable




Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this
 environment.
 


templateName
String templateName

 The name of the configuration template used to originally launch this
 environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer.
 For single-instance environments, the IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
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.
 


abortableOperationInProgress
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.
 


health
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
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment.
 For more information, see Health Colors and Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
com.amazonaws.internal.SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 








Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationResult extends Object implements Serializable




Serialized Fields


s3Bucket
String s3Bucket

 The name of the Amazon S3 bucket created.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application to delete.
 


terminateEnvByForce
Boolean terminateEnvByForce

 When set to true, running environments will be terminated before deleting
 the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application to delete releases from.
 


versionLabel
String versionLabel

 The label of the version to delete.
 


deleteSourceBundle
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
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application to delete the configuration template from.
 


templateName
String templateName

 The name of the configuration template to delete.
 








Class com.amazonaws.services.elasticbeanstalk.model.DeleteEnvironmentConfigurationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application the environment is associated with.
 


environmentName
String environmentName

 The name of the environment to delete the draft configuration from.
 








Class com.amazonaws.services.elasticbeanstalk.model.Deployment extends Object implements Serializable




Serialized Fields


versionLabel
String versionLabel

 The version label of the application version in the deployment.
 


deploymentId
Long deploymentId

 The ID of the deployment. This number increases by one each time that you
 deploy source code or change instance configuration settings.
 


status
String status

 The status of the deployment:
 
 
  In Progress : The deployment is in progress.
  Deployed : The deployment succeeded.
  Failed : The deployment failed.
 


deploymentTime
Date deploymentTime

 For in-progress deployments, the time that the deloyment started.
 
 
 For completed deployments, the time that the deployment ended.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationNames
com.amazonaws.internal.SdkInternalList<T> applicationNames

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to only include those with the specified names.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationsResult extends Object implements Serializable




Serialized Fields


applications
com.amazonaws.internal.SdkInternalList<T> applications

 This parameter contains a list of ApplicationDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to only include ones that are associated with the specified application.
 


versionLabels
com.amazonaws.internal.SdkInternalList<T> versionLabels

 If specified, restricts the returned descriptions to only include ones
 that have the specified version labels.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsResult extends Object implements Serializable




Serialized Fields


applicationVersions
com.amazonaws.internal.SdkInternalList<T> applicationVersions

 List of ApplicationVersionDescription objects sorted by
 order of creation.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
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.
 


templateName
String templateName

 The name of the configuration template whose configuration options you
 want to describe.
 


environmentName
String environmentName

 The name of the environment whose configuration options you want to
 describe.
 


solutionStackName
String solutionStackName

 The name of the solution stack whose configuration options you want to
 describe.
 


options
com.amazonaws.internal.SdkInternalList<T> options

 If specified, restricts the descriptions to only the specified options.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsResult extends Object implements Serializable




Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack these configuration options belong to.
 


options
com.amazonaws.internal.SdkInternalList<T> options

 A list of ConfigurationOptionDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The application for the environment or configuration template.
 


templateName
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.
 


environmentName
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsResult extends Object implements Serializable




Serialized Fields


configurationSettings
com.amazonaws.internal.SdkInternalList<T> configurationSettings

 A list of ConfigurationSettingsDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentName
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.
 


environmentId
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.
 


attributeNames
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthResult extends Object implements Serializable




Serialized Fields


environmentName
String environmentName

 The AWS Elastic Beanstalk environment name.
 


healthStatus
String healthStatus

 Contains the response body with information about the health of the
 environment.
 


status
String status

 Returns the health status value of the environment. For more information,
 see Health Colors and Statuses.
 


color
String color

 Returns the color indicator that tells you information about the health
 of the environment. For more information, see Health Colors and Statuses.
 


causes
com.amazonaws.internal.SdkInternalList<T> causes

 Returns potential causes for the reported status.
 


applicationMetrics
ApplicationMetrics applicationMetrics


instancesHealth
InstanceHealthSummary instancesHealth


refreshedAt
Date refreshedAt

 The date and time the information was last refreshed.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
String environmentId

 The environment ID of the target environment.
 


environmentName
String environmentName

 The name of the target environment.
 


nextToken
String nextToken

 The pagination token returned by a previous request.
 


maxItems
Integer maxItems

 The maximum number of items to return for a single request.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResult extends Object implements Serializable




Serialized Fields


managedActionHistoryItems
com.amazonaws.internal.SdkInternalList<T> managedActionHistoryItems

 A list of completed and failed managed actions.
 


nextToken
String nextToken

 A pagination token that you pass to
 DescribeEnvironmentManagedActionHistory to get the next page of
 results.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentName
String environmentName

 The name of the target environment.
 


environmentId
String environmentId

 The environment ID of the target environment.
 


status
String status

 To show only actions with a particular status, specify a status.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionsResult extends Object implements Serializable




Serialized Fields


managedActions
com.amazonaws.internal.SdkInternalList<T> managedActions

 A list of upcoming and in-progress managed actions.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentResourcesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
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.
 


environmentName
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentResourcesResult extends Object implements Serializable




Serialized Fields


environmentResources
EnvironmentResourceDescription environmentResources

 A list of EnvironmentResourceDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to include only those that are associated with this application.
 


versionLabel
String versionLabel

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to include only those that are associated with this application version.
 


environmentIds
com.amazonaws.internal.SdkInternalList<T> environmentIds

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to include only those that have the specified IDs.
 


environmentNames
com.amazonaws.internal.SdkInternalList<T> environmentNames

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to include only those that have the specified names.
 


includeDeleted
Boolean includeDeleted

 Indicates whether to include deleted environments:
 
 
 true: Environments that have been deleted after
 IncludedDeletedBackTo are displayed.
 
 
 false: Do not include deleted environments.
 


includedDeletedBackTo
Date includedDeletedBackTo

 If specified when IncludeDeleted is set to true
 , then environments deleted after this date are displayed.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsResult extends Object implements Serializable




Serialized Fields


environments
com.amazonaws.internal.SdkInternalList<T> environments

 Returns an EnvironmentDescription list.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to include only those associated with this application.
 


versionLabel
String versionLabel

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to those associated with this application version.
 


templateName
String templateName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to those that are associated with this environment configuration.
 


environmentId
String environmentId

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to those associated with this environment.
 


environmentName
String environmentName

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to those associated with this environment.
 


requestId
String requestId

 If specified, AWS Elastic Beanstalk restricts the described events to
 include only those associated with this request ID.
 


severity
String severity

 If specified, limits the events returned from this call to include only
 those with the specified severity or higher.
 


startTime
Date startTime

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to those that occur on or after this time.
 


endTime
Date endTime

 If specified, AWS Elastic Beanstalk restricts the returned descriptions
 to those that occur up to, but not including, the EndTime.
 


maxRecords
Integer maxRecords

 Specifies the maximum number of events that can be returned, beginning
 with the most recent event.
 


nextToken
String nextToken

 Pagination token. If specified, the events return the next batch of
 results.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeEventsResult extends Object implements Serializable




Serialized Fields


events
com.amazonaws.internal.SdkInternalList<T> events

 A list of EventDescription.
 


nextToken
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeInstancesHealthRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentName
String environmentName

 Specifies the AWS Elastic Beanstalk environment name.
 


environmentId
String environmentId

 Specifies the AWS Elastic Beanstalk environment ID.
 


attributeNames
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.
 


nextToken
String nextToken

 Specifies the next token of the request.
 








Class com.amazonaws.services.elasticbeanstalk.model.DescribeInstancesHealthResult extends Object implements Serializable




Serialized Fields


instanceHealthList
com.amazonaws.internal.SdkInternalList<T> instanceHealthList

 Contains the response body with information about the health of the
 instance.
 


refreshedAt
Date refreshedAt

 The date and time the information was last refreshed.
 


nextToken
String nextToken

 The next token.
 








Class com.amazonaws.services.elasticbeanstalk.model.ElasticBeanstalkServiceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription extends Object implements Serializable




Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this
 environment.
 


templateName
String templateName

 The name of the configuration template used to originally launch this
 environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer.
 For single-instance environments, the IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
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.
 


abortableOperationInProgress
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.
 


health
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
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment.
 For more information, see Health Colors and Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
com.amazonaws.internal.SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentInfoDescription extends Object implements Serializable




Serialized Fields


infoType
String infoType

 The type of information retrieved.
 


ec2InstanceId
String ec2InstanceId

 The Amazon EC2 Instance ID for this information.
 


sampleTimestamp
Date sampleTimestamp

 The time stamp when this information was retrieved.
 


message
String message

 The retrieved information.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentLink extends Object implements Serializable




Serialized Fields


linkName
String linkName

 The name of the link.
 


environmentName
String environmentName

 The name of the linked environment (the dependency).
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourceDescription extends Object implements Serializable




Serialized Fields


environmentName
String environmentName

 The name of the environment.
 


autoScalingGroups
com.amazonaws.internal.SdkInternalList<T> autoScalingGroups

 The AutoScalingGroups used by this environment.
 


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The Amazon EC2 instances used by this environment.
 


launchConfigurations
com.amazonaws.internal.SdkInternalList<T> launchConfigurations

 The Auto Scaling launch configurations in use by this environment.
 


loadBalancers
com.amazonaws.internal.SdkInternalList<T> loadBalancers

 The LoadBalancers in use by this environment.
 


triggers
com.amazonaws.internal.SdkInternalList<T> triggers

 The AutoScaling triggers in use by this environment.
 


queues
com.amazonaws.internal.SdkInternalList<T> queues

 The queues used by this environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourcesDescription extends Object implements Serializable




Serialized Fields


loadBalancer
LoadBalancerDescription loadBalancer

 Describes the LoadBalancer.
 








Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentTier extends Object implements Serializable




Serialized Fields


name
String name

 The name of this environment tier.
 


type
String type

 The type of this environment tier.
 


version
String version

 The version of this environment tier.
 








Class com.amazonaws.services.elasticbeanstalk.model.EventDescription extends Object implements Serializable




Serialized Fields


eventDate
Date eventDate

 The date when the event occurred.
 


message
String message

 The event message.
 


applicationName
String applicationName

 The application associated with the event.
 


versionLabel
String versionLabel

 The release label for the application version associated with this event.
 


templateName
String templateName

 The name of the configuration associated with this event.
 


environmentName
String environmentName

 The name of the environment associated with this event.
 


requestId
String requestId

 The web service request ID for the activity of this event.
 


severity
String severity

 The severity level of this event.
 








Class com.amazonaws.services.elasticbeanstalk.model.Instance extends Object implements Serializable




Serialized Fields


id
String id

 The ID of the Amazon EC2 instance.
 








Class com.amazonaws.services.elasticbeanstalk.model.InstanceHealthSummary extends Object implements Serializable




Serialized Fields


noData
Integer noData

 Grey. AWS Elastic Beanstalk and the health agent are reporting no
 data on an instance.
 


unknown
Integer unknown

 Grey. AWS Elastic Beanstalk and the health agent are reporting an
 insufficient amount of data on an instance.
 


pending
Integer pending

 Grey. An operation is in progress on an instance within the
 command timeout.
 


ok
Integer ok

 Green. An instance is passing health checks and the health agent
 is not reporting any problems.
 


info
Integer info

 Green. An operation is in progress on an instance.
 


warning
Integer warning

 Yellow. The health agent is reporting a moderate number of request
 failures or other issues for an instance or environment.
 


degraded
Integer degraded

 Red. The health agent is reporting a high number of request
 failures or other issues for an instance or environment.
 


severe
Integer severe

 Red. The health agent is reporting a very high number of request
 failures or other issues for an instance or environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.Latency extends Object implements Serializable




Serialized Fields


p999
Double p999

 The average latency for the slowest 0.1 percent of requests over the last
 10 seconds.
 


p99
Double p99

 The average latency for the slowest 1 percent of requests over the last
 10 seconds.
 


p95
Double p95

 The average latency for the slowest 5 percent of requests over the last
 10 seconds.
 


p90
Double p90

 The average latency for the slowest 10 percent of requests over the last
 10 seconds.
 


p85
Double p85

 The average latency for the slowest 15 percent of requests over the last
 10 seconds.
 


p75
Double p75

 The average latency for the slowest 25 percent of requests over the last
 10 seconds.
 


p50
Double p50

 The average latency for the slowest 50 percent of requests over the last
 10 seconds.
 


p10
Double p10

 The average latency for the slowest 90 percent of requests over the last
 10 seconds.
 








Class com.amazonaws.services.elasticbeanstalk.model.LaunchConfiguration extends Object implements Serializable




Serialized Fields


name
String name

 The name of the launch configuration.
 








Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksResult extends Object implements Serializable




Serialized Fields


solutionStacks
com.amazonaws.internal.SdkInternalList<T> solutionStacks

 A list of available solution stacks.
 


solutionStackDetails
com.amazonaws.internal.SdkInternalList<T> solutionStackDetails

 A list of available solution stacks and their
 SolutionStackDescription.
 








Class com.amazonaws.services.elasticbeanstalk.model.Listener extends Object implements Serializable




Serialized Fields


protocol
String protocol

 The protocol that is used by the Listener.
 


port
Integer port

 The port that is used by the Listener.
 








Class com.amazonaws.services.elasticbeanstalk.model.LoadBalancer extends Object implements Serializable




Serialized Fields


name
String name

 The name of the LoadBalancer.
 








Class com.amazonaws.services.elasticbeanstalk.model.LoadBalancerDescription extends Object implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the LoadBalancer.
 


domain
String domain

 The domain name of the LoadBalancer.
 


listeners
com.amazonaws.internal.SdkInternalList<T> listeners

 A list of Listeners used by the LoadBalancer.
 








Class com.amazonaws.services.elasticbeanstalk.model.ManagedAction extends Object implements Serializable




Serialized Fields


actionId
String actionId

 A unique identifier for the managed action.
 


actionDescription
String actionDescription

 A description of the managed action.
 


actionType
String actionType

 The type of managed action.
 


status
String status

 The status of the managed action. If the action is Scheduled
 , you can apply it immediately with ApplyEnvironmentManagedAction.
 


windowStartTime
Date windowStartTime

 The start time of the maintenance window in which the managed action will
 execute.
 








Class com.amazonaws.services.elasticbeanstalk.model.ManagedActionHistoryItem extends Object implements Serializable




Serialized Fields


actionId
String actionId

 A unique identifier for the managed action.
 


actionType
String actionType

 The type of the managed action.
 


actionDescription
String actionDescription

 A description of the managed action.
 


failureType
String failureType

 If the action failed, the type of failure.
 


status
String status

 The status of the action.
 


failureDescription
String failureDescription

 If the action failed, a description of the failure.
 


executedTime
Date executedTime

 The date and time that the action started executing.
 


finishedTime
Date finishedTime

 The date and time that the action finished executing.
 








Class com.amazonaws.services.elasticbeanstalk.model.ManagedActionInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.OperationInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.OptionRestrictionRegex extends Object implements Serializable




Serialized Fields


pattern
String pattern

 The regular expression pattern that a string configuration option value
 with this restriction must match.
 


label
String label

 A unique name representing this regular expression.
 








Class com.amazonaws.services.elasticbeanstalk.model.OptionSpecification extends Object implements Serializable




Serialized Fields


resourceName
String resourceName

 A unique resource name for a time-based scaling configuration option.
 


namespace
String namespace

 A unique namespace identifying the option's associated AWS resource.
 


optionName
String optionName

 The name of the configuration option.
 








Class com.amazonaws.services.elasticbeanstalk.model.Queue extends Object implements Serializable




Serialized Fields


name
String name

 The name of the queue.
 


uRL
String uRL

 The URL of the queue.
 








Class com.amazonaws.services.elasticbeanstalk.model.RebuildEnvironmentRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
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.
 


environmentName
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.RequestEnvironmentInfoRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
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.
 


environmentName
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.
 


infoType
String infoType

 The type of information to request.
 








Class com.amazonaws.services.elasticbeanstalk.model.RestartAppServerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
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.
 


environmentName
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
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.
 


environmentName
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.
 


infoType
String infoType

 The type of information to retrieve.
 








Class com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoResult extends Object implements Serializable




Serialized Fields


environmentInfo
com.amazonaws.internal.SdkInternalList<T> environmentInfo

 The EnvironmentInfoDescription of the environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.S3Location extends Object implements Serializable




Serialized Fields


s3Bucket
String s3Bucket

 The Amazon S3 bucket where the data is located.
 


s3Key
String s3Key

 The Amazon S3 key where the data is located.
 








Class com.amazonaws.services.elasticbeanstalk.model.S3LocationNotInServiceRegionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.S3SubscriptionRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.SingleInstanceHealth extends Object implements Serializable




Serialized Fields


instanceId
String instanceId

 The ID of the Amazon EC2 instance.
 


healthStatus
String healthStatus

 Returns the health status of the specified instance. For more
 information, see Health Colors and Statuses.
 


color
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.
 


causes
com.amazonaws.internal.SdkInternalList<T> causes

 Represents the causes, which provide more information about the current
 health status.
 


launchedAt
Date launchedAt

 The time at which the EC2 instance was launched.
 


applicationMetrics
ApplicationMetrics applicationMetrics


system
SystemStatus system


deployment
Deployment deployment

 Information about the most recent deployment to an instance.
 


availabilityZone
String availabilityZone

 The availability zone in which the instance runs.
 


instanceType
String instanceType

 The instance's type.
 








Class com.amazonaws.services.elasticbeanstalk.model.SolutionStackDescription extends Object implements Serializable




Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack.
 


permittedFileTypes
com.amazonaws.internal.SdkInternalList<T> permittedFileTypes

 The permitted file types allowed for a solution stack.
 








Class com.amazonaws.services.elasticbeanstalk.model.SourceBundleDeletionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.SourceConfiguration extends Object implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application associated with the configuration.
 


templateName
String templateName

 The name of the configuration template.
 








Class com.amazonaws.services.elasticbeanstalk.model.StatusCodes extends Object implements Serializable




Serialized Fields


status2xx
Integer status2xx

 The percentage of requests over the last 10 seconds that resulted in a
 2xx (200, 201, etc.) status code.
 


status3xx
Integer status3xx

 The percentage of requests over the last 10 seconds that resulted in a
 3xx (300, 301, etc.) status code.
 


status4xx
Integer status4xx

 The percentage of requests over the last 10 seconds that resulted in a
 4xx (400, 401, etc.) status code.
 


status5xx
Integer status5xx

 The percentage of requests over the last 10 seconds that resulted in a
 5xx (500, 501, etc.) status code.
 








Class com.amazonaws.services.elasticbeanstalk.model.SwapEnvironmentCNAMEsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceEnvironmentId
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.
 


sourceEnvironmentName
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.
 


destinationEnvironmentId
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.
 


destinationEnvironmentName
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.SystemStatus extends Object implements Serializable




Serialized Fields


cPUUtilization
CPUUtilization cPUUtilization


loadAverage
com.amazonaws.internal.SdkInternalList<T> loadAverage

 Load average in the last 1-minute and 5-minute periods. For more
 information, see Operating System Metrics.
 








Class com.amazonaws.services.elasticbeanstalk.model.Tag extends Object implements Serializable




Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Class com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


environmentId
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.
 


environmentName
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.
 


terminateResources
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
 


forceTerminate
Boolean forceTerminate

 Terminates the target environment even if another environment in the same
 group is dependent on it.
 








Class com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentResult extends Object implements Serializable




Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this
 environment.
 


templateName
String templateName

 The name of the configuration template used to originally launch this
 environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer.
 For single-instance environments, the IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
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.
 


abortableOperationInProgress
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.
 


health
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
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment.
 For more information, see Health Colors and Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
com.amazonaws.internal.SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 








Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationVersionsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyBucketsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyConfigurationTemplatesException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.TooManyEnvironmentsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticbeanstalk.model.Trigger extends Object implements Serializable




Serialized Fields


name
String name

 The name of the trigger.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application to update. If no such application is found,
 UpdateApplication returns an
 InvalidParameterValue error.
 


description
String description

 A new description for the application.
 
 
 Default: If not specified, AWS Elastic Beanstalk does not update the
 description.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationResult extends Object implements Serializable




Serialized Fields


application
ApplicationDescription application

 The ApplicationDescription of the application.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application associated with this version.
 
 
 If no application is found with this name, UpdateApplication
 returns an InvalidParameterValue error.
 


versionLabel
String versionLabel

 The name of the version to update.
 
 
 If no application version is found with this label,
 UpdateApplication returns an
 InvalidParameterValue error.
 


description
String description

 A new description for this release.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionResult extends Object implements Serializable




Serialized Fields


applicationVersion
ApplicationVersionDescription applicationVersion

 The ApplicationVersionDescription of the application version.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
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.
 


templateName
String templateName

 The name of the configuration template to update.
 
 
 If no configuration template is found with this name,
 UpdateConfigurationTemplate returns an
 InvalidParameterValue error.
 


description
String description

 A new description for the configuration.
 


optionSettings
com.amazonaws.internal.SdkInternalList<T> optionSettings

 A list of configuration option settings to update with the new specified
 option value.
 


optionsToRemove
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.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateResult extends Object implements Serializable




Serialized Fields


solutionStackName
String solutionStackName

 The name of the solution stack this configuration set uses.
 


applicationName
String applicationName

 The name of the application associated with this configuration set.
 


templateName
String templateName

 If not null, the name of the configuration template for this
 configuration set.
 


description
String description

 Describes this configuration set.
 


environmentName
String environmentName

 If not null, the name of the environment for this
 configuration set.
 


deploymentStatus
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.
 


dateCreated
Date dateCreated

 The date (in UTC time) when this configuration set was created.
 


dateUpdated
Date dateUpdated

 The date (in UTC time) when this configuration set was last modified.
 


optionSettings
com.amazonaws.internal.SdkInternalList<T> optionSettings

 A list of the configuration options and their values in this
 configuration set.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application with which the environment is associated.
 


environmentId
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.
 


environmentName
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.
 


groupName
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.
 


description
String description

 If this parameter is specified, AWS Elastic Beanstalk updates the
 description of this environment.
 


tier
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.
 


versionLabel
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.
 


templateName
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.
 


solutionStackName
String solutionStackName

 This specifies the platform version that the environment will run after
 the environment is updated.
 


optionSettings
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.
 


optionsToRemove
com.amazonaws.internal.SdkInternalList<T> optionsToRemove

 A list of custom user-defined configuration options to remove from the
 configuration set for this environment.
 








Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentResult extends Object implements Serializable




Serialized Fields


environmentName
String environmentName

 The name of this environment.
 


environmentId
String environmentId

 The ID of this environment.
 


applicationName
String applicationName

 The name of the application associated with this environment.
 


versionLabel
String versionLabel

 The application version deployed in this environment.
 


solutionStackName
String solutionStackName

 The name of the SolutionStack deployed with this
 environment.
 


templateName
String templateName

 The name of the configuration template used to originally launch this
 environment.
 


description
String description

 Describes this environment.
 


endpointURL
String endpointURL

 For load-balanced, autoscaling environments, the URL to the LoadBalancer.
 For single-instance environments, the IP address of the instance.
 


cNAME
String cNAME

 The URL to the CNAME for this environment.
 


dateCreated
Date dateCreated

 The creation date for this environment.
 


dateUpdated
Date dateUpdated

 The last modified date for this environment.
 


status
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.
 


abortableOperationInProgress
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.
 


health
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
 


healthStatus
String healthStatus

 Returns the health status of the application running in your environment.
 For more information, see Health Colors and Statuses.
 


resources
EnvironmentResourcesDescription resources

 The description of the AWS resources used by this environment.
 


tier
EnvironmentTier tier

 Describes the current tier of this environment.
 


environmentLinks
com.amazonaws.internal.SdkInternalList<T> environmentLinks

 A list of links to other environments in the same group.
 








Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


applicationName
String applicationName

 The name of the application that the configuration template or
 environment belongs to.
 


templateName
String templateName

 The name of the configuration template to validate the settings against.
 
 
 Condition: You cannot specify both this and an environment name.
 


environmentName
String environmentName

 The name of the environment to validate the settings against.
 
 
 Condition: You cannot specify both this and a configuration template
 name.
 


optionSettings
com.amazonaws.internal.SdkInternalList<T> optionSettings

 A list of the options and desired values to evaluate.
 








Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsResult extends Object implements Serializable




Serialized Fields


messages
com.amazonaws.internal.SdkInternalList<T> messages

 A list of ValidationMessage.
 








Class com.amazonaws.services.elasticbeanstalk.model.ValidationMessage extends Object implements Serializable




Serialized Fields


message
String message

 A message describing the error or warning.
 


severity
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.
 


namespace
String namespace



optionName
String optionName









Package com.amazonaws.services.elasticfilesystem.model




Class com.amazonaws.services.elasticfilesystem.model.BadRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.CreateFileSystemRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


creationToken
String creationToken

 String of up to 64 ASCII characters. Amazon EFS uses this to ensure
 idempotent creation.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateFileSystemResult extends Object implements Serializable




Serialized Fields


ownerId
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.
 


creationToken
String creationToken

 Opaque string specified in the request.
 


fileSystemId
String fileSystemId

 The file system ID assigned by Amazon EFS.
 


creationTime
Date creationTime

 The time at which the file system was created, in seconds, since
 1970-01-01T00:00:00Z.
 


lifeCycleState
String lifeCycleState

 A predefined string value that indicates the lifecycle phase of the file
 system.
 


name
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.
 


numberOfMountTargets
Integer numberOfMountTargets

 The current number of mount targets (see CreateMountTarget) the
 file system has.
 


sizeInBytes
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.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateMountTargetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system for which to create the mount target.
 


subnetId
String subnetId

 The ID of the subnet to add the mount target in.
 


ipAddress
String ipAddress

 A valid IPv4 address within the address range of the specified subnet.
 


securityGroups
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.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateMountTargetResult extends Object implements Serializable




Serialized Fields


ownerId
String ownerId

 The AWS account ID that owns the resource.
 


mountTargetId
String mountTargetId

 The system-assigned mount target ID.
 


fileSystemId
String fileSystemId

 The ID of the file system for which the mount target is intended.
 


subnetId
String subnetId

 The ID of the subnet that the mount target is in.
 


lifeCycleState
String lifeCycleState

 The lifecycle state the mount target is in.
 


ipAddress
String ipAddress

 The address at which the file system may be mounted via the mount target.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface that Amazon EFS created when it created
 the mount target.
 








Class com.amazonaws.services.elasticfilesystem.model.CreateTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fileSystemId
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.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 An array of Tag objects to add. Each Tag object
 is a key-value pair.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteFileSystemRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fileSystemId
String fileSystemId

 The ID of the file system you want to delete.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteMountTargetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mountTargetId
String mountTargetId

 String. The ID of the mount target to delete.
 








Class com.amazonaws.services.elasticfilesystem.model.DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fileSystemId
String fileSystemId

 String. The ID of the file system whose tags you want to delete.
 


tagKeys
com.amazonaws.internal.SdkInternalList<T> tagKeys

 A list of tag keys to delete.
 








Class com.amazonaws.services.elasticfilesystem.model.DependencyTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


maxItems
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.
 


marker
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.
 


creationToken
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).
 


fileSystemId
String fileSystemId

 Optional string. File system ID whose description you want to retrieve.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemsResult extends Object implements Serializable




Serialized Fields


marker
String marker

 A string, present if provided by caller in the request.
 


fileSystems
com.amazonaws.internal.SdkInternalList<T> fileSystems

 An array of file system descriptions.
 


nextMarker
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.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mountTargetId
String mountTargetId

 The ID of the mount target whose security groups you want to retrieve.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetSecurityGroupsResult extends Object implements Serializable




Serialized Fields


securityGroups
com.amazonaws.internal.SdkInternalList<T> securityGroups

 An array of security groups.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


maxItems
Integer maxItems

 Optional. Maximum number of mount targets to return in the response. It
 must be an integer with a value greater than zero.
 


marker
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.
 


fileSystemId
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.
 


mountTargetId
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.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetsResult extends Object implements Serializable




Serialized Fields


marker
String marker

 If the request included the Marker, the response returns
 that value in this field.
 


mountTargets
com.amazonaws.internal.SdkInternalList<T> mountTargets

 Returns the file system's mount targets as an array of
 MountTargetDescription objects.
 


nextMarker
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.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


maxItems
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.
 


marker
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.
 


fileSystemId
String fileSystemId

 The ID of the file system whose tag set you want to retrieve.
 








Class com.amazonaws.services.elasticfilesystem.model.DescribeTagsResult extends Object implements Serializable




Serialized Fields


marker
String marker

 If the request included a Marker, the response returns that
 value in this field.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 Returns tags associated with the file system as an array of
 Tag objects.
 


nextMarker
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.
 








Class com.amazonaws.services.elasticfilesystem.model.FileSystemAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode


fileSystemId
String fileSystemId








Class com.amazonaws.services.elasticfilesystem.model.FileSystemDescription extends Object implements Serializable




Serialized Fields


ownerId
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.
 


creationToken
String creationToken

 Opaque string specified in the request.
 


fileSystemId
String fileSystemId

 The file system ID assigned by Amazon EFS.
 


creationTime
Date creationTime

 The time at which the file system was created, in seconds, since
 1970-01-01T00:00:00Z.
 


lifeCycleState
String lifeCycleState

 A predefined string value that indicates the lifecycle phase of the file
 system.
 


name
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.
 


numberOfMountTargets
Integer numberOfMountTargets

 The current number of mount targets (see CreateMountTarget) the
 file system has.
 


sizeInBytes
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.
 








Class com.amazonaws.services.elasticfilesystem.model.FileSystemInUseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.FileSystemLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.FileSystemSize extends Object implements Serializable




Serialized Fields


value
Long value

 The latest known metered size, in bytes, of data stored in the file
 system.
 


timestamp
Date timestamp

 The time at which the size of data, returned in the Value
 field, was determined. The value is the integer number of seconds since
 1970-01-01T00:00:00Z.
 








Class com.amazonaws.services.elasticfilesystem.model.IncorrectFileSystemLifeCycleStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.IncorrectMountTargetStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.IpAddressInUseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.ModifyMountTargetSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mountTargetId
String mountTargetId

 The ID of the mount target whose security groups you want to modify.
 


securityGroups
com.amazonaws.internal.SdkInternalList<T> securityGroups

 An array of up to five VPC security group IDs.
 








Class com.amazonaws.services.elasticfilesystem.model.MountTargetConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.MountTargetDescription extends Object implements Serializable




Serialized Fields


ownerId
String ownerId

 The AWS account ID that owns the resource.
 


mountTargetId
String mountTargetId

 The system-assigned mount target ID.
 


fileSystemId
String fileSystemId

 The ID of the file system for which the mount target is intended.
 


subnetId
String subnetId

 The ID of the subnet that the mount target is in.
 


lifeCycleState
String lifeCycleState

 The lifecycle state the mount target is in.
 


ipAddress
String ipAddress

 The address at which the file system may be mounted via the mount target.
 


networkInterfaceId
String networkInterfaceId

 The ID of the network interface that Amazon EFS created when it created
 the mount target.
 








Class com.amazonaws.services.elasticfilesystem.model.MountTargetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.NetworkInterfaceLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.NoFreeAddressesInSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.SecurityGroupLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.SecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.SubnetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Class com.amazonaws.services.elasticfilesystem.model.Tag extends Object implements Serializable




Serialized Fields


key
String key

 Tag key, a string. The key must not start with "aws:".
 


value
String value

 Value of the tag key.
 








Class com.amazonaws.services.elasticfilesystem.model.UnsupportedAvailabilityZoneException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode








Package com.amazonaws.services.elasticloadbalancing.model




Class com.amazonaws.services.elasticloadbalancing.model.AccessLog extends Object implements Serializable




Serialized Fields


enabled
Boolean enabled

 Specifies whether access log is enabled for the load balancer.
 


s3BucketName
String s3BucketName

 The name of the Amazon S3 bucket where the access logs are stored.
 


emitInterval
Integer emitInterval

 The interval for publishing the access logs. You can specify an interval
 of either 5 minutes or 60 minutes.
 
 
 Default: 60 minutes
 


s3BucketPrefix
String s3BucketPrefix

 The logical hierarchy you created for your Amazon S3 bucket, for example
 my-bucket-prefix/prod. If the prefix is not provided, the
 log is placed at the root level of the bucket.
 








Class com.amazonaws.services.elasticloadbalancing.model.AdditionalAttribute extends Object implements Serializable




Serialized Fields


key
String key

 This parameter is reserved.
 


value
String value

 This parameter is reserved.
 








Class com.amazonaws.services.elasticloadbalancing.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerNames
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames

 The name of the load balancer. You can specify one load balancer only.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.elasticloadbalancing.model.AddTagsResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.AppCookieStickinessPolicy extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The mnemonic name for the policy being created. The name must be unique
 within a set of policies for this load balancer.
 


cookieName
String cookieName

 The name of the application cookie used for stickiness.
 








Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


securityGroups
com.amazonaws.internal.SdkInternalList<T> securityGroups

 The IDs of the security groups to associate with the load balancer. Note
 that you cannot specify the name of the security group.
 








Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerResult extends Object implements Serializable




Serialized Fields


securityGroups
com.amazonaws.internal.SdkInternalList<T> securityGroups

 The IDs of the security groups associated with the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


subnets
com.amazonaws.internal.SdkInternalList<T> subnets

 The IDs of the subnets to add for the load balancer. You can add only one
 subnet per Availability Zone.
 








Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsResult extends Object implements Serializable




Serialized Fields


subnets
com.amazonaws.internal.SdkInternalList<T> subnets

 The IDs of the subnets attached to the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.BackendServerDescription extends Object implements Serializable




Serialized Fields


instancePort
Integer instancePort

 The port on which the back-end server is listening.
 


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 The names of the policies enabled for the back-end server.
 








Class com.amazonaws.services.elasticloadbalancing.model.CertificateNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


healthCheck
HealthCheck healthCheck

 The configuration information for the new health check.
 








Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckResult extends Object implements Serializable




Serialized Fields


healthCheck
HealthCheck healthCheck

 The updated health check.
 








Class com.amazonaws.services.elasticloadbalancing.model.ConnectionDraining extends Object implements Serializable




Serialized Fields


enabled
Boolean enabled

 Specifies whether connection draining is enabled for the load balancer.
 


timeout
Integer timeout

 The maximum time, in seconds, to keep the existing connections open
 before deregistering the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.ConnectionSettings extends Object implements Serializable




Serialized Fields


idleTimeout
Integer idleTimeout

 The time, in seconds, that the connection is allowed to be idle (no data
 has been sent over the connection) before it is closed by the load
 balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the policy being created. Policy names must consist of
 alphanumeric characters and dashes (-). This name must be unique within
 the set of policies for this load balancer.
 


cookieName
String cookieName

 The name of the application cookie used for stickiness.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the policy being created. Policy names must consist of
 alphanumeric characters and dashes (-). This name must be unique within
 the set of policies for this load balancer.
 


cookieExpirationPeriod
Long cookieExpirationPeriod

 The time period, in seconds, after which the cookie should be considered
 stale. If you do not specify this parameter, the sticky session lasts for
 the duration of the browser session.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


listeners
com.amazonaws.internal.SdkInternalList<T> listeners

 The listeners.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the load balancer policy to be created. This name must be
 unique within the set of policies for this load balancer.
 


policyTypeName
String policyTypeName

 The name of the base policy type. To get the list of policy types, use
 DescribeLoadBalancerPolicyTypes.
 


policyAttributes
com.amazonaws.internal.SdkInternalList<T> policyAttributes

 The attributes for the policy.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 
 
 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.
 


listeners
com.amazonaws.internal.SdkInternalList<T> listeners

 The listeners.
 
 
 For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing
 Developer Guide.
 


availabilityZones
com.amazonaws.internal.SdkInternalList<T> availabilityZones

 One or more Availability Zones from the same region as the load balancer.
 Traffic is equally distributed across all specified Availability Zones.
 
 
 You must specify at least one Availability Zone.
 
 
 You can add more Availability Zones after you create the load balancer
 using EnableAvailabilityZonesForLoadBalancer.
 


subnets
com.amazonaws.internal.SdkInternalList<T> subnets

 The IDs of the subnets in your VPC to attach to the load balancer.
 Specify one subnet per Availability Zone specified in
 AvailabilityZones.
 


securityGroups
com.amazonaws.internal.SdkInternalList<T> securityGroups

 The IDs of the security groups to assign to the load balancer.
 


scheme
String scheme

 The type of a load balancer. Valid only for load balancers in a VPC.
 
 
 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.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 A list of tags to assign to the load balancer.
 
 
 For more information about tagging your load balancer, see Tagging in the Elastic Load Balancing Developer Guide.
 








Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerResult extends Object implements Serializable




Serialized Fields


dNSName
String dNSName

 The DNS name of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.CrossZoneLoadBalancing extends Object implements Serializable




Serialized Fields


enabled
Boolean enabled

 Specifies whether cross-zone load balancing is enabled for the load
 balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerPorts
com.amazonaws.internal.SdkInternalList<T> loadBalancerPorts

 The client port numbers of the listeners.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerListenersResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyName
String policyName

 The name of the policy.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The IDs of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerResult extends Object implements Serializable




Serialized Fields


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The remaining instances registered with the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The IDs of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthResult extends Object implements Serializable




Serialized Fields


instanceStates
com.amazonaws.internal.SdkInternalList<T> instanceStates

 Information about the health of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesResult extends Object implements Serializable




Serialized Fields


loadBalancerAttributes
LoadBalancerAttributes loadBalancerAttributes

 Information about the load balancer attributes.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 The names of the policies.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesResult extends Object implements Serializable




Serialized Fields


policyDescriptions
com.amazonaws.internal.SdkInternalList<T> policyDescriptions

 Information about the policies.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyTypeNames
com.amazonaws.internal.SdkInternalList<T> policyTypeNames

 The names of the policy types. If no names are specified, describes all
 policy types defined by Elastic Load Balancing.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesResult extends Object implements Serializable




Serialized Fields


policyTypeDescriptions
com.amazonaws.internal.SdkInternalList<T> policyTypeDescriptions

 Information about the policy types.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerNames
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames

 The names of the load balancers.
 


marker
String marker

 The marker for the next set of results. (You received this marker from a
 previous call.)
 


pageSize
Integer pageSize

 The maximum number of results to return with this call (a number from 1
 to 400). The default is 400.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersResult extends Object implements Serializable




Serialized Fields


loadBalancerDescriptions
com.amazonaws.internal.SdkInternalList<T> loadBalancerDescriptions

 Information about the load balancers.
 


nextMarker
String nextMarker

 The marker to use when requesting the next set of results. If there are
 no additional results, the string is empty.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerNames
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames

 The names of the load balancers.
 








Class com.amazonaws.services.elasticloadbalancing.model.DescribeTagsResult extends Object implements Serializable




Serialized Fields


tagDescriptions
com.amazonaws.internal.SdkInternalList<T> tagDescriptions

 Information about the tags.
 








Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


subnets
com.amazonaws.internal.SdkInternalList<T> subnets

 The IDs of the subnets.
 








Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsResult extends Object implements Serializable




Serialized Fields


subnets
com.amazonaws.internal.SdkInternalList<T> subnets

 The IDs of the remaining subnets for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


availabilityZones
com.amazonaws.internal.SdkInternalList<T> availabilityZones

 The Availability Zones.
 








Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerResult extends Object implements Serializable




Serialized Fields


availabilityZones
com.amazonaws.internal.SdkInternalList<T> availabilityZones

 The remaining Availability Zones for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.DuplicateListenerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.DuplicateLoadBalancerNameException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.DuplicatePolicyNameException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.DuplicateTagKeysException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


availabilityZones
com.amazonaws.internal.SdkInternalList<T> availabilityZones

 The Availability Zones. These must be in the same region as the load
 balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerResult extends Object implements Serializable




Serialized Fields


availabilityZones
com.amazonaws.internal.SdkInternalList<T> availabilityZones

 The updated list of Availability Zones for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.HealthCheck extends Object implements Serializable




Serialized Fields


target
String target

 The instance being checked. The protocol is either TCP, HTTP, HTTPS, or
 SSL. The range of valid ports is one (1) through 65535.
 
 
 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.
 


interval
Integer interval

 The approximate interval, in seconds, between health checks of an
 individual instance.
 


timeout
Integer timeout

 The amount of time, in seconds, during which no response means a failed
 health check.
 
 
 This value must be less than the Interval value.
 


unhealthyThreshold
Integer unhealthyThreshold

 The number of consecutive health check failures required before moving
 the instance to the Unhealthy state.
 


healthyThreshold
Integer healthyThreshold

 The number of consecutive health checks successes required before moving
 the instance to the Healthy state.
 








Class com.amazonaws.services.elasticloadbalancing.model.Instance extends Object implements Serializable




Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 








Class com.amazonaws.services.elasticloadbalancing.model.InstanceState extends Object implements Serializable




Serialized Fields


instanceId
String instanceId

 The ID of the instance.
 


state
String state

 The current state of the instance.
 
 
 Valid values: InService | OutOfService |
 Unknown
 


reasonCode
String reasonCode

 Information about the cause of OutOfService instances.
 Specifically, whether the cause is Elastic Load Balancing or the
 instance.
 
 
 Valid values: ELB | Instance | N/A
 


description
String description

 A description of the instance state. This string can contain one or more
 of the following messages.
 
 
 
 
 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.
 
 
 








Class com.amazonaws.services.elasticloadbalancing.model.InvalidConfigurationRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidInstanceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidSchemeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidSecurityGroupException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.LBCookieStickinessPolicy extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The name for the policy being created. The name must be unique within the
 set of policies for this load balancer.
 


cookieExpirationPeriod
Long cookieExpirationPeriod

 The time period, in seconds, after which the cookie should be considered
 stale. If this parameter is not specified, the stickiness session lasts
 for the duration of the browser session.
 








Class com.amazonaws.services.elasticloadbalancing.model.Listener extends Object implements Serializable




Serialized Fields


protocol
String protocol

 The load balancer transport protocol to use for routing: HTTP, HTTPS,
 TCP, or SSL.
 


loadBalancerPort
Integer loadBalancerPort

 The port on which the load balancer is listening. On EC2-VPC, you can
 specify any port from the range 1-65535. On EC2-Classic, you can specify
 any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
 


instanceProtocol
String instanceProtocol

 The protocol to use for routing traffic to back-end instances: HTTP,
 HTTPS, TCP, or SSL.
 
 
 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.
 


instancePort
Integer instancePort

 The port on which the instance is listening.
 


sSLCertificateId
String sSLCertificateId

 The Amazon Resource Name (ARN) of the server certificate.
 








Class com.amazonaws.services.elasticloadbalancing.model.ListenerDescription extends Object implements Serializable




Serialized Fields


listener
Listener listener


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 The policies. If there are no policies enabled, the list is empty.
 








Class com.amazonaws.services.elasticloadbalancing.model.ListenerNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributes extends Object implements Serializable




Serialized Fields


crossZoneLoadBalancing
CrossZoneLoadBalancing crossZoneLoadBalancing

 If enabled, the load balancer routes the request traffic evenly across
 all back-end instances regardless of the Availability Zones.
 
 
 For more information, see Enable Cross-Zone Load Balancing in the Elastic Load Balancing
 Developer Guide.
 


accessLog
AccessLog accessLog

 If enabled, the load balancer captures detailed information of all
 requests and delivers the information to the Amazon S3 bucket that you
 specify.
 
 
 For more information, see Enable Access Logs in the Elastic Load Balancing Developer
 Guide.
 


connectionDraining
ConnectionDraining connectionDraining

 If enabled, the load balancer allows existing requests to complete before
 the load balancer shifts traffic away from a deregistered or unhealthy
 back-end instance.
 
 
 For more information, see Enable Connection Draining in the Elastic Load Balancing
 Developer Guide.
 


connectionSettings
ConnectionSettings connectionSettings

 If enabled, the load balancer allows the connections to remain idle (no
 data is sent over the connection) for the specified duration.
 
 
 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.
 


additionalAttributes
com.amazonaws.internal.SdkInternalList<T> additionalAttributes

 This parameter is reserved.
 








Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerDescription extends Object implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


dNSName
String dNSName

 The external DNS name of the load balancer.
 


canonicalHostedZoneName
String canonicalHostedZoneName

 The Amazon Route 53 hosted zone associated with the load balancer.
 
 
 For more information, see Using Domain Names With Elastic Load Balancing in the Elastic
 Load Balancing Developer Guide.
 


canonicalHostedZoneNameID
String canonicalHostedZoneNameID

 The ID of the Amazon Route 53 hosted zone name associated with the load
 balancer.
 


listenerDescriptions
com.amazonaws.internal.SdkInternalList<T> listenerDescriptions

 The listeners for the load balancer.
 


policies
Policies policies

 The policies defined for the load balancer.
 


backendServerDescriptions
com.amazonaws.internal.SdkInternalList<T> backendServerDescriptions

 Information about the back-end servers.
 


availabilityZones
com.amazonaws.internal.SdkInternalList<T> availabilityZones

 The Availability Zones for the load balancer.
 


subnets
com.amazonaws.internal.SdkInternalList<T> subnets

 The IDs of the subnets for the load balancer.
 


vPCId
String vPCId

 The ID of the VPC for the load balancer.
 


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The IDs of the instances for the load balancer.
 


healthCheck
HealthCheck healthCheck

 Information about the health checks conducted on the load balancer.
 


sourceSecurityGroup
SourceSecurityGroup sourceSecurityGroup

 The security group that you can use as part of your inbound rules for
 your load balancer's back-end application instances. To only allow
 traffic from load balancers, add a security group rule to your back end
 instance that specifies this source security group as the inbound source.
 


securityGroups
com.amazonaws.internal.SdkInternalList<T> securityGroups

 The security groups for the load balancer. Valid only for load balancers
 in a VPC.
 


createdTime
Date createdTime

 The date and time the load balancer was created.
 


scheme
String scheme

 The type of load balancer. Valid only for load balancers in a VPC.
 
 
 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.
 








Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerAttributes
LoadBalancerAttributes loadBalancerAttributes

 The attributes of the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesResult extends Object implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerAttributes
LoadBalancerAttributes loadBalancerAttributes








Class com.amazonaws.services.elasticloadbalancing.model.Policies extends Object implements Serializable




Serialized Fields


appCookieStickinessPolicies
com.amazonaws.internal.SdkInternalList<T> appCookieStickinessPolicies

 The stickiness policies created using
 CreateAppCookieStickinessPolicy.
 


lBCookieStickinessPolicies
com.amazonaws.internal.SdkInternalList<T> lBCookieStickinessPolicies

 The stickiness policies created using
 CreateLBCookieStickinessPolicy.
 


otherPolicies
com.amazonaws.internal.SdkInternalList<T> otherPolicies

 The policies other than the stickiness policies.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttribute extends Object implements Serializable




Serialized Fields


attributeName
String attributeName

 The name of the attribute.
 


attributeValue
String attributeValue

 The value of the attribute.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeDescription extends Object implements Serializable




Serialized Fields


attributeName
String attributeName

 The name of the attribute.
 


attributeValue
String attributeValue

 The value of the attribute.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttributeTypeDescription extends Object implements Serializable




Serialized Fields


attributeName
String attributeName

 The name of the attribute.
 


attributeType
String attributeType

 The type of the attribute. For example, Boolean or
 Integer.
 


description
String description

 A description of the attribute.
 


defaultValue
String defaultValue

 The default value of the attribute, if applicable.
 


cardinality
String cardinality

 The cardinality of the attribute.
 
 
 Valid values:
 
 
 ONE(1) : Single value required
 ZERO_OR_ONE(0..1) : Up to one value can be supplied
 ZERO_OR_MORE(0..*) : Optional. Multiple values are allowed
 ONE_OR_MORE(1..*0) : Required. Multiple values are allowed
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyDescription extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyTypeName
String policyTypeName

 The name of the policy type.
 


policyAttributeDescriptions
com.amazonaws.internal.SdkInternalList<T> policyAttributeDescriptions

 The policy attributes.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeDescription extends Object implements Serializable




Serialized Fields


policyTypeName
String policyTypeName

 The name of the policy type.
 


description
String description

 A description of the policy type.
 


policyAttributeTypeDescriptions
com.amazonaws.internal.SdkInternalList<T> policyAttributeTypeDescriptions

 The description of the policy attributes associated with the policies
 defined by Elastic Load Balancing.
 








Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The IDs of the instances.
 








Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerResult extends Object implements Serializable




Serialized Fields


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The updated list of instances for the load balancer.
 








Class com.amazonaws.services.elasticloadbalancing.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerNames
com.amazonaws.internal.SdkInternalList<T> loadBalancerNames

 The name of the load balancer. You can specify a maximum of one load
 balancer name.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 The list of tag keys to remove.
 








Class com.amazonaws.services.elasticloadbalancing.model.RemoveTagsResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerListenerSSLCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerPort
Integer loadBalancerPort

 The port that uses the specified SSL certificate.
 


sSLCertificateId
String sSLCertificateId

 The Amazon Resource Name (ARN) of the SSL certificate.
 








Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerListenerSSLCertificateResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


instancePort
Integer instancePort

 The port number associated with the back-end server.
 


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 The names of the policies. If the list is empty, then all current polices
 are removed from the back-end server.
 








Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


loadBalancerPort
Integer loadBalancerPort

 The external port of the load balancer for the policy.
 


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 The names of the policies. If the list is empty, the current policy is
 removed from the listener.
 








Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerResult extends Object implements Serializable




Class com.amazonaws.services.elasticloadbalancing.model.SourceSecurityGroup extends Object implements Serializable




Serialized Fields


ownerAlias
String ownerAlias

 The owner of the security group.
 


groupName
String groupName

 The name of the security group.
 








Class com.amazonaws.services.elasticloadbalancing.model.SubnetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.Tag extends Object implements Serializable




Serialized Fields


key
String key

 The key of the tag.
 


value
String value

 The value of the tag.
 








Class com.amazonaws.services.elasticloadbalancing.model.TagDescription extends Object implements Serializable




Serialized Fields


loadBalancerName
String loadBalancerName

 The name of the load balancer.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 The tags.
 








Class com.amazonaws.services.elasticloadbalancing.model.TagKeyOnly extends Object implements Serializable




Serialized Fields


key
String key

 The name of the key.
 








Class com.amazonaws.services.elasticloadbalancing.model.TooManyLoadBalancersException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.TooManyPoliciesException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticloadbalancing.model.TooManyTagsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.elasticmapreduce.model




Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceGroups
com.amazonaws.internal.SdkInternalList<T> instanceGroups

 Instance Groups to add.
 


jobFlowId
String jobFlowId

 Job flow in which to add the instance groups.
 








Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsResult extends Object implements Serializable




Serialized Fields


jobFlowId
String jobFlowId

 The job flow ID in which the instance groups are added.
 


instanceGroupIds
com.amazonaws.internal.SdkInternalList<T> instanceGroupIds

 Instance group IDs of the newly created instance groups.
 








Class com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobFlowId
String jobFlowId

 A string that uniquely identifies the job flow. This identifier is
 returned by RunJobFlow and can also be obtained from
 ListClusters.
 


steps
com.amazonaws.internal.SdkInternalList<T> steps

 A list of StepConfig to be executed by the job flow.
 








Class com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsResult extends Object implements Serializable




Serialized Fields


stepIds
com.amazonaws.internal.SdkInternalList<T> stepIds

 The identifiers of the list of steps added to the job flow.
 








Class com.amazonaws.services.elasticmapreduce.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceId
String resourceId

 The Amazon EMR resource identifier to which tags will be added. This
 value must be a cluster identifier.
 


tags
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.
 








Class com.amazonaws.services.elasticmapreduce.model.AddTagsResult extends Object implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.Application extends Object implements Serializable




Serialized Fields


name
String name

 The name of the application.
 


version
String version

 The version of the application.
 


args
com.amazonaws.internal.SdkInternalList<T> args

 Arguments for Amazon EMR to pass to the application.
 


additionalInfo
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.
 








Class com.amazonaws.services.elasticmapreduce.model.BootstrapActionConfig extends Object implements Serializable




Serialized Fields


name
String name

 The name of the bootstrap action.
 


scriptBootstrapAction
ScriptBootstrapActionConfig scriptBootstrapAction

 The script run by the bootstrap action.
 








Class com.amazonaws.services.elasticmapreduce.model.BootstrapActionDetail extends Object implements Serializable




Serialized Fields


bootstrapActionConfig
BootstrapActionConfig bootstrapActionConfig

 A description of the bootstrap action.
 








Class com.amazonaws.services.elasticmapreduce.model.Cluster extends Object implements Serializable




Serialized Fields


id
String id

 The unique identifier for the cluster.
 


name
String name

 The name of the cluster.
 


status
ClusterStatus status

 The current status details about the cluster.
 


ec2InstanceAttributes
Ec2InstanceAttributes ec2InstanceAttributes


logUri
String logUri

 The path to the Amazon S3 location where logs for this cluster are
 stored.
 


requestedAmiVersion
String requestedAmiVersion

 The AMI version requested for this cluster.
 


runningAmiVersion
String runningAmiVersion

 The AMI version running on this cluster.
 


releaseLabel
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.
 


autoTerminate
Boolean autoTerminate

 Specifies whether the cluster should terminate after completing all
 steps.
 


terminationProtected
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.
 


visibleToAllUsers
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.
 


applications
com.amazonaws.internal.SdkInternalList<T> applications

 The applications installed on this cluster.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 A list of tags associated with a cluster.
 


serviceRole
String serviceRole

 The IAM role that will be assumed by the Amazon EMR service to access AWS
 resources on your behalf.
 


normalizedInstanceHours
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.
 


masterPublicDnsName
String masterPublicDnsName

 The public DNS name of the master EC2 instance.
 


configurations
com.amazonaws.internal.SdkInternalList<T> configurations

 
 Amazon EMR releases 4.x or later.
 
 
 
 The list of Configurations supplied to the EMR cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterStateChangeReason extends Object implements Serializable




Serialized Fields


code
String code

 The programmatic code for the state change reason.
 


message
String message

 The descriptive message for the state change reason.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterStatus extends Object implements Serializable




Serialized Fields


state
String state

 The current state of the cluster.
 


stateChangeReason
ClusterStateChangeReason stateChangeReason

 The reason for the cluster status change.
 


timeline
ClusterTimeline timeline

 A timeline that represents the status of a cluster over the lifetime of
 the cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterSummary extends Object implements Serializable




Serialized Fields


id
String id

 The unique identifier for the cluster.
 


name
String name

 The name of the cluster.
 


status
ClusterStatus status

 The details about the current status of the cluster.
 


normalizedInstanceHours
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.
 








Class com.amazonaws.services.elasticmapreduce.model.ClusterTimeline extends Object implements Serializable




Serialized Fields


creationDateTime
Date creationDateTime

 The creation date and time of the cluster.
 


readyDateTime
Date readyDateTime

 The date and time when the cluster was ready to execute steps.
 


endDateTime
Date endDateTime

 The date and time when the cluster was terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.Command extends Object implements Serializable




Serialized Fields


name
String name

 The name of the command.
 


scriptPath
String scriptPath

 The Amazon S3 location of the command script.
 


args
com.amazonaws.internal.SdkInternalList<T> args

 Arguments for Amazon EMR to pass to the command for execution.
 








Class com.amazonaws.services.elasticmapreduce.model.Configuration extends Object implements Serializable




Serialized Fields


classification
String classification

 The classification of a configuration. For more information see, Amazon EMR Configurations.
 


configurations
com.amazonaws.internal.SdkInternalList<T> configurations

 A list of configurations you apply to this configuration object.
 


properties
com.amazonaws.internal.SdkInternalMap<K,V> properties

 A set of properties supplied to the Configuration object.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusterId
String clusterId

 The identifier of the cluster to describe.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeClusterResult extends Object implements Serializable




Serialized Fields


cluster
Cluster cluster

 This output contains the details for the requested cluster.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeJobFlowsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


createdAfter
Date createdAfter

 Return only job flows created after this date and time.
 


createdBefore
Date createdBefore

 Return only job flows created before this date and time.
 


jobFlowIds
com.amazonaws.internal.SdkInternalList<T> jobFlowIds

 Return only job flows whose job flow ID is contained in this list.
 


jobFlowStates
com.amazonaws.internal.SdkInternalList<T> jobFlowStates

 Return only job flows whose state is contained in this list.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeJobFlowsResult extends Object implements Serializable




Serialized Fields


jobFlows
com.amazonaws.internal.SdkInternalList<T> jobFlows

 A list of job flows matching the parameters supplied.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeStepRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusterId
String clusterId

 The identifier of the cluster with steps to describe.
 


stepId
String stepId

 The identifier of the step to describe.
 








Class com.amazonaws.services.elasticmapreduce.model.DescribeStepResult extends Object implements Serializable




Serialized Fields


step
Step step

 The step details for the requested step identifier.
 








Class com.amazonaws.services.elasticmapreduce.model.EbsBlockDevice extends Object implements Serializable




Serialized Fields


volumeSpecification
VolumeSpecification volumeSpecification

 EBS volume specifications such as volume type, IOPS, and size(GiB) that
 will be requested for the EBS volume attached to an EC2 instance in the
 cluster.
 


device
String device

 The device name that is exposed to the instance, such as /dev/sdh.
 








Class com.amazonaws.services.elasticmapreduce.model.EbsBlockDeviceConfig extends Object implements Serializable




Serialized Fields


volumeSpecification
VolumeSpecification volumeSpecification

 EBS volume specifications such as volume type, IOPS, and size(GiB) that
 will be requested for the EBS volume attached to an EC2 instance in the
 cluster.
 


volumesPerInstance
Integer volumesPerInstance

 Number of EBS volumes with specific volume configuration, that will be
 associated with every instance in the instance group
 








Class com.amazonaws.services.elasticmapreduce.model.EbsConfiguration extends Object implements Serializable




Serialized Fields


ebsBlockDeviceConfigs
com.amazonaws.internal.SdkInternalList<T> ebsBlockDeviceConfigs


ebsOptimized
Boolean ebsOptimized








Class com.amazonaws.services.elasticmapreduce.model.EbsVolume extends Object implements Serializable




Serialized Fields


device
String device

 The device name that is exposed to the instance, such as /dev/sdh.
 


volumeId
String volumeId

 The volume identifier of the EBS volume.
 








Class com.amazonaws.services.elasticmapreduce.model.Ec2InstanceAttributes extends Object implements Serializable




Serialized Fields


ec2KeyName
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".
 


ec2SubnetId
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.
 


ec2AvailabilityZone
String ec2AvailabilityZone

 The Availability Zone in which the cluster will run.
 


iamInstanceProfile
String iamInstanceProfile

 The IAM role that was specified when the job flow was launched. The EC2
 instances of the job flow assume this role.
 


emrManagedMasterSecurityGroup
String emrManagedMasterSecurityGroup

 The identifier of the Amazon EC2 security group for the master node.
 


emrManagedSlaveSecurityGroup
String emrManagedSlaveSecurityGroup

 The identifier of the Amazon EC2 security group for the slave nodes.
 


serviceAccessSecurityGroup
String serviceAccessSecurityGroup

 The identifier of the Amazon EC2 security group for the Amazon EMR
 service to access clusters in VPC private subnets.
 


additionalMasterSecurityGroups
com.amazonaws.internal.SdkInternalList<T> additionalMasterSecurityGroups

 A list of additional Amazon EC2 security group IDs for the master node.
 


additionalSlaveSecurityGroups
com.amazonaws.internal.SdkInternalList<T> additionalSlaveSecurityGroups

 A list of additional Amazon EC2 security group IDs for the slave nodes.
 








Class com.amazonaws.services.elasticmapreduce.model.HadoopJarStepConfig extends Object implements Serializable




Serialized Fields


properties
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.
 


jar
String jar

 A path to a JAR file run during the step.
 


mainClass
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.
 


args
com.amazonaws.internal.SdkInternalList<T> args

 A list of command line arguments passed to the JAR file's main function
 when executed.
 








Class com.amazonaws.services.elasticmapreduce.model.HadoopStepConfig extends Object implements Serializable




Serialized Fields


jar
String jar

 The path to the JAR file that runs during the step.
 


properties
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.
 


mainClass
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.
 


args
com.amazonaws.internal.SdkInternalList<T> args

 The list of command line arguments to pass to the JAR file's main
 function for execution.
 








Class com.amazonaws.services.elasticmapreduce.model.Instance extends Object implements Serializable




Serialized Fields


id
String id

 The unique identifier for the instance in Amazon EMR.
 


ec2InstanceId
String ec2InstanceId

 The unique identifier of the instance in Amazon EC2.
 


publicDnsName
String publicDnsName

 The public DNS name of the instance.
 


publicIpAddress
String publicIpAddress

 The public IP address of the instance.
 


privateDnsName
String privateDnsName

 The private DNS name of the instance.
 


privateIpAddress
String privateIpAddress

 The private IP address of the instance.
 


status
InstanceStatus status

 The current status of the instance.
 


instanceGroupId
String instanceGroupId

 The identifier of the instance group to which this instance belongs.
 


ebsVolumes
com.amazonaws.internal.SdkInternalList<T> ebsVolumes

 The list of EBS volumes that are attached to this instance.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroup extends Object implements Serializable




Serialized Fields


id
String id

 The identifier of the instance group.
 


name
String name

 The name of the instance group.
 


market
String market

 The marketplace to provision instances for this group. Valid values are
 ON_DEMAND or SPOT.
 


instanceGroupType
String instanceGroupType

 The type of the instance group. Valid values are MASTER, CORE or TASK.
 


bidPrice
String bidPrice

 The bid price for each EC2 instance in the instance group when launching
 nodes as Spot Instances, expressed in USD.
 


instanceType
String instanceType

 The EC2 instance type for all instances in the instance group.
 


requestedInstanceCount
Integer requestedInstanceCount

 The target number of instances for the instance group.
 


runningInstanceCount
Integer runningInstanceCount

 The number of instances currently running in this instance group.
 


status
InstanceGroupStatus status

 The current status of the instance group.
 


configurations
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).
 


ebsBlockDevices
com.amazonaws.internal.SdkInternalList<T> ebsBlockDevices

 The EBS block devices that are mapped to this instance group.
 


ebsOptimized
Boolean ebsOptimized

 If the instance group is EBS-optimized. An Amazon EBS–optimized instance
 uses an optimized configuration stack and provides additional, dedicated
 capacity for Amazon EBS I/O.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupConfig extends Object implements Serializable




Serialized Fields


name
String name

 Friendly name given to the instance group.
 


market
String market

 Market type of the Amazon EC2 instances used to create a cluster node.
 


instanceRole
String instanceRole

 The role of the instance group in the cluster.
 


bidPrice
String bidPrice

 Bid price for each Amazon EC2 instance in the instance group when
 launching nodes as Spot Instances, expressed in USD.
 


instanceType
String instanceType

 The Amazon EC2 instance type for all instances in the instance group.
 


instanceCount
Integer instanceCount

 Target number of instances for the instance group.
 


configurations
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).
 


ebsConfiguration
EbsConfiguration ebsConfiguration

 EBS configurations that will be attached to each Amazon EC2 instance in
 the instance group.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupDetail extends Object implements Serializable




Serialized Fields


instanceGroupId
String instanceGroupId

 Unique identifier for the instance group.
 


name
String name

 Friendly name for the instance group.
 


market
String market

 Market type of the Amazon EC2 instances used to create a cluster node.
 


instanceRole
String instanceRole

 Instance group role in the cluster
 


bidPrice
String bidPrice

 Bid price for EC2 Instances when launching nodes as Spot Instances,
 expressed in USD.
 


instanceType
String instanceType

 Amazon EC2 Instance type.
 


instanceRequestCount
Integer instanceRequestCount

 Target number of instances to run in the instance group.
 


instanceRunningCount
Integer instanceRunningCount

 Actual count of running instances.
 


state
String state

 State of instance group. The following values are deprecated: STARTING,
 TERMINATED, and FAILED.
 


lastStateChangeReason
String lastStateChangeReason

 Details regarding the state of the instance group.
 


creationDateTime
Date creationDateTime

 The date/time the instance group was created.
 


startDateTime
Date startDateTime

 The date/time the instance group was started.
 


readyDateTime
Date readyDateTime

 The date/time the instance group was available to the cluster.
 


endDateTime
Date endDateTime

 The date/time the instance group was terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupModifyConfig extends Object implements Serializable




Serialized Fields


instanceGroupId
String instanceGroupId

 Unique ID of the instance group to expand or shrink.
 


instanceCount
Integer instanceCount

 Target size for the instance group.
 


eC2InstanceIdsToTerminate
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.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupStateChangeReason extends Object implements Serializable




Serialized Fields


code
String code

 The programmable code for the state change reason.
 


message
String message

 The status change reason description.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupStatus extends Object implements Serializable




Serialized Fields


state
String state

 The current state of the instance group.
 


stateChangeReason
InstanceGroupStateChangeReason stateChangeReason

 The status change reason details for the instance group.
 


timeline
InstanceGroupTimeline timeline

 The timeline of the instance group status over time.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupTimeline extends Object implements Serializable




Serialized Fields


creationDateTime
Date creationDateTime

 The creation date and time of the instance group.
 


readyDateTime
Date readyDateTime

 The date and time when the instance group became ready to perform tasks.
 


endDateTime
Date endDateTime

 The date and time when the instance group terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceStateChangeReason extends Object implements Serializable




Serialized Fields


code
String code

 The programmable code for the state change reason.
 


message
String message

 The status change reason description.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceStatus extends Object implements Serializable




Serialized Fields


state
String state

 The current state of the instance.
 


stateChangeReason
InstanceStateChangeReason stateChangeReason

 The details of the status change reason for the instance.
 


timeline
InstanceTimeline timeline

 The timeline of the instance status over time.
 








Class com.amazonaws.services.elasticmapreduce.model.InstanceTimeline extends Object implements Serializable




Serialized Fields


creationDateTime
Date creationDateTime

 The creation date and time of the instance.
 


readyDateTime
Date readyDateTime

 The date and time when the instance was ready to perform tasks.
 


endDateTime
Date endDateTime

 The date and time when the instance was terminated.
 








Class com.amazonaws.services.elasticmapreduce.model.InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticmapreduce.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticmapreduce.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode

 The error code associated with the exception.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowDetail extends Object implements Serializable




Serialized Fields


jobFlowId
String jobFlowId

 The job flow identifier.
 


name
String name

 The name of the job flow.
 


logUri
String logUri

 The location in Amazon S3 where log files for the job are stored.
 


amiVersion
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.
 


executionStatusDetail
JobFlowExecutionStatusDetail executionStatusDetail

 Describes the execution status of the job flow.
 


instances
JobFlowInstancesDetail instances

 Describes the Amazon EC2 instances of the job flow.
 


steps
com.amazonaws.internal.SdkInternalList<T> steps

 A list of steps run by the job flow.
 


bootstrapActions
com.amazonaws.internal.SdkInternalList<T> bootstrapActions

 A list of the bootstrap actions run by the job flow.
 


supportedProducts
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.
 


visibleToAllUsers
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.
 


jobFlowRole
String jobFlowRole

 The IAM role that was specified when the job flow was launched. The EC2
 instances of the job flow assume this role.
 


serviceRole
String serviceRole

 The IAM role that will be assumed by the Amazon EMR service to access AWS
 resources on your behalf.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowExecutionStatusDetail extends Object implements Serializable




Serialized Fields


state
String state

 The state of the job flow.
 


creationDateTime
Date creationDateTime

 The creation date and time of the job flow.
 


startDateTime
Date startDateTime

 The start date and time of the job flow.
 


readyDateTime
Date readyDateTime

 The date and time when the job flow was ready to start running bootstrap
 actions.
 


endDateTime
Date endDateTime

 The completion date and time of the job flow.
 


lastStateChangeReason
String lastStateChangeReason

 Description of the job flow last changed state.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesConfig extends Object implements Serializable




Serialized Fields


masterInstanceType
String masterInstanceType

 The EC2 instance type of the master node.
 


slaveInstanceType
String slaveInstanceType

 The EC2 instance type of the slave nodes.
 


instanceCount
Integer instanceCount

 The number of Amazon EC2 instances used to execute the job flow.
 


instanceGroups
com.amazonaws.internal.SdkInternalList<T> instanceGroups

 Configuration for the job flow's instance groups.
 


ec2KeyName
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."
 


placement
PlacementType placement

 The Availability Zone the job flow will run in.
 


keepJobFlowAliveWhenNoSteps
Boolean keepJobFlowAliveWhenNoSteps

 Specifies whether the job flow should be kept alive after completing all
 steps.
 


terminationProtected
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.
 


hadoopVersion
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.
 


ec2SubnetId
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.
 


emrManagedMasterSecurityGroup
String emrManagedMasterSecurityGroup

 The identifier of the Amazon EC2 security group for the master node.
 


emrManagedSlaveSecurityGroup
String emrManagedSlaveSecurityGroup

 The identifier of the Amazon EC2 security group for the slave nodes.
 


serviceAccessSecurityGroup
String serviceAccessSecurityGroup

 The identifier of the Amazon EC2 security group for the Amazon EMR
 service to access clusters in VPC private subnets.
 


additionalMasterSecurityGroups
com.amazonaws.internal.SdkInternalList<T> additionalMasterSecurityGroups

 A list of additional Amazon EC2 security group IDs for the master node.
 


additionalSlaveSecurityGroups
com.amazonaws.internal.SdkInternalList<T> additionalSlaveSecurityGroups

 A list of additional Amazon EC2 security group IDs for the slave nodes.
 








Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesDetail extends Object implements Serializable




Serialized Fields


masterInstanceType
String masterInstanceType

 The Amazon EC2 master node instance type.
 


masterPublicDnsName
String masterPublicDnsName

 The DNS name of the master node.
 


masterInstanceId
String masterInstanceId

 The Amazon EC2 instance identifier of the master node.
 


slaveInstanceType
String slaveInstanceType

 The Amazon EC2 slave node instance type.
 


instanceCount
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.
 


instanceGroups
com.amazonaws.internal.SdkInternalList<T> instanceGroups

 Details about the job flow's instance groups.
 


normalizedInstanceHours
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.
 


ec2KeyName
String ec2KeyName

 The name of an Amazon EC2 key pair that can be used to ssh to the master
 node of job flow.
 


ec2SubnetId
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.
 


placement
PlacementType placement

 The Amazon EC2 Availability Zone for the job flow.
 


keepJobFlowAliveWhenNoSteps
Boolean keepJobFlowAliveWhenNoSteps

 Specifies whether the job flow should terminate after completing all
 steps.
 


terminationProtected
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.
 


hadoopVersion
String hadoopVersion

 The Hadoop version for the job flow.
 








Class com.amazonaws.services.elasticmapreduce.model.KeyValue extends Object implements Serializable




Serialized Fields


key
String key

 The unique identifier of a key value pair.
 


value
String value

 The value part of the identified key.
 








Class com.amazonaws.services.elasticmapreduce.model.ListBootstrapActionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusterId
String clusterId

 The cluster identifier for the bootstrap actions to list .
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve .
 








Class com.amazonaws.services.elasticmapreduce.model.ListBootstrapActionsResult extends Object implements Serializable




Serialized Fields


bootstrapActions
com.amazonaws.internal.SdkInternalList<T> bootstrapActions

 The bootstrap actions associated with the cluster .
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve .
 








Class com.amazonaws.services.elasticmapreduce.model.ListClustersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


createdAfter
Date createdAfter

 The creation date and time beginning value filter for listing clusters .
 


createdBefore
Date createdBefore

 The creation date and time end value filter for listing clusters .
 


clusterStates
com.amazonaws.internal.SdkInternalList<T> clusterStates

 The cluster state filters to apply when listing clusters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListClustersResult extends Object implements Serializable




Serialized Fields


clusters
com.amazonaws.internal.SdkInternalList<T> clusters

 The list of clusters for the account based on the given filters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusterId
String clusterId

 The identifier of the cluster for which to list the instance groups.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstanceGroupsResult extends Object implements Serializable




Serialized Fields


instanceGroups
com.amazonaws.internal.SdkInternalList<T> instanceGroups

 The list of instance groups for the cluster and given filters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstancesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusterId
String clusterId

 The identifier of the cluster for which to list the instances.
 


instanceGroupId
String instanceGroupId

 The identifier of the instance group for which to list the instances.
 


instanceGroupTypes
com.amazonaws.internal.SdkInternalList<T> instanceGroupTypes

 The type of instance group for which to list the instances.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListInstancesResult extends Object implements Serializable




Serialized Fields


instances
com.amazonaws.internal.SdkInternalList<T> instances

 The list of instances for the cluster and given filters.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListStepsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


clusterId
String clusterId

 The identifier of the cluster for which to list the steps.
 


stepStates
com.amazonaws.internal.SdkInternalList<T> stepStates

 The filter to limit the step list based on certain states.
 


stepIds
com.amazonaws.internal.SdkInternalList<T> stepIds

 The filter to limit the step list based on the identifier of the steps.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ListStepsResult extends Object implements Serializable




Serialized Fields


steps
com.amazonaws.internal.SdkInternalList<T> steps

 The filtered list of steps for the cluster.
 


marker
String marker

 The pagination token that indicates the next set of results to retrieve.
 








Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceGroups
com.amazonaws.internal.SdkInternalList<T> instanceGroups

 Instance groups to change.
 








Class com.amazonaws.services.elasticmapreduce.model.PlacementType extends Object implements Serializable




Serialized Fields


availabilityZone
String availabilityZone

 The Amazon EC2 Availability Zone for the job flow.
 








Class com.amazonaws.services.elasticmapreduce.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceId
String resourceId

 The Amazon EMR resource identifier from which tags will be removed. This
 value must be a cluster identifier.
 


tagKeys
com.amazonaws.internal.SdkInternalList<T> tagKeys

 A list of tag keys to remove from a resource.
 








Class com.amazonaws.services.elasticmapreduce.model.RemoveTagsResult extends Object implements Serializable




Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 The name of the job flow.
 


logUri
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.
 


additionalInfo
String additionalInfo

 A JSON string for selecting additional features.
 


amiVersion
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:
 
 
 The version number of the AMI to use, for example, "2.0."
 
 
 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.
 


releaseLabel
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.
 


instances
JobFlowInstancesConfig instances

 A specification of the number and type of Amazon EC2 instances on which
 to run the job flow.
 


steps
com.amazonaws.internal.SdkInternalList<T> steps

 A list of steps to be executed by the job flow.
 


bootstrapActions
com.amazonaws.internal.SdkInternalList<T> bootstrapActions

 A list of bootstrap actions that will be run before Hadoop is started on
 the cluster nodes.
 


supportedProducts
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:
 
 
 "mapr-m3" - launch the job flow using MapR M3 Edition.
 "mapr-m5" - launch the job flow using MapR M5 Edition.
 


newSupportedProducts
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:
 
 
 "mapr-m3" - launch the cluster using MapR M3 Edition.
 "mapr-m5" - launch the cluster using MapR M5 Edition.
 "mapr" with the user arguments specifying "--edition,m3" or
 "--edition,m5" - launch the job flow using MapR M3 or M5 Edition
 respectively.
 "mapr-m7" - launch the cluster using MapR M7 Edition.
 "hunk" - launch the cluster with the Hunk Big Data Analtics Platform.
 
 "hue"- launch the cluster with Hue installed.
 "spark" - launch the cluster with Apache Spark installed.
 "ganglia" - launch the cluster with the Ganglia Monitoring System
 installed.
 


applications
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.
 


configurations
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.
 


visibleToAllUsers
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.
 


jobFlowRole
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.
 


serviceRole
String serviceRole

 The IAM role that will be assumed by the Amazon EMR service to access AWS
 resources on your behalf.
 


tags
com.amazonaws.internal.SdkInternalList<T> tags

 A list of tags to associate with a cluster and propagate to Amazon EC2
 instances.
 








Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowResult extends Object implements Serializable




Serialized Fields


jobFlowId
String jobFlowId

 An unique identifier for the job flow.
 








Class com.amazonaws.services.elasticmapreduce.model.ScriptBootstrapActionConfig extends Object implements Serializable




Serialized Fields


path
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.
 


args
com.amazonaws.internal.SdkInternalList<T> args

 A list of command line arguments to pass to the bootstrap action script.
 








Class com.amazonaws.services.elasticmapreduce.model.SetTerminationProtectionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobFlowIds
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 .
 


terminationProtected
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.
 








Class com.amazonaws.services.elasticmapreduce.model.SetVisibleToAllUsersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobFlowIds
com.amazonaws.internal.SdkInternalList<T> jobFlowIds

 Identifiers of the job flows to receive the new visibility setting.
 


visibleToAllUsers
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.
 








Class com.amazonaws.services.elasticmapreduce.model.Step extends Object implements Serializable




Serialized Fields


id
String id

 The identifier of the cluster step.
 


name
String name

 The name of the cluster step.
 


config
HadoopStepConfig config

 The Hadoop job configuration of the cluster step.
 


actionOnFailure
String actionOnFailure

 This specifies what action to take when the cluster step fails. Possible
 values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
 


status
StepStatus status

 The current execution status details of the cluster step.
 








Class com.amazonaws.services.elasticmapreduce.model.StepConfig extends Object implements Serializable




Serialized Fields


name
String name

 The name of the job flow step.
 


actionOnFailure
String actionOnFailure

 The action to take if the job flow step fails.
 


hadoopJarStep
HadoopJarStepConfig hadoopJarStep

 The JAR file used for the job flow step.
 








Class com.amazonaws.services.elasticmapreduce.model.StepDetail extends Object implements Serializable




Serialized Fields


stepConfig
StepConfig stepConfig

 The step configuration.
 


executionStatusDetail
StepExecutionStatusDetail executionStatusDetail

 The description of the step status.
 








Class com.amazonaws.services.elasticmapreduce.model.StepExecutionStatusDetail extends Object implements Serializable




Serialized Fields


state
String state

 The state of the job flow step.
 


creationDateTime
Date creationDateTime

 The creation date and time of the step.
 


startDateTime
Date startDateTime

 The start date and time of the step.
 


endDateTime
Date endDateTime

 The completion date and time of the step.
 


lastStateChangeReason
String lastStateChangeReason

 A description of the step's current state.
 








Class com.amazonaws.services.elasticmapreduce.model.StepStateChangeReason extends Object implements Serializable




Serialized Fields


code
String code

 The programmable code for the state change reason. Note: Currently, the
 service provides no code for the state change.
 


message
String message

 The descriptive message for the state change reason.
 








Class com.amazonaws.services.elasticmapreduce.model.StepStatus extends Object implements Serializable




Serialized Fields


state
String state

 The execution state of the cluster step.
 


stateChangeReason
StepStateChangeReason stateChangeReason

 The reason for the step execution status change.
 


timeline
StepTimeline timeline

 The timeline of the cluster step status over time.
 








Class com.amazonaws.services.elasticmapreduce.model.StepSummary extends Object implements Serializable




Serialized Fields


id
String id

 The identifier of the cluster step.
 


name
String name

 The name of the cluster step.
 


config
HadoopStepConfig config

 The Hadoop job configuration of the cluster step.
 


actionOnFailure
String actionOnFailure

 This specifies what action to take when the cluster step fails. Possible
 values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.
 


status
StepStatus status

 The current execution status details of the cluster step.
 








Class com.amazonaws.services.elasticmapreduce.model.StepTimeline extends Object implements Serializable




Serialized Fields


creationDateTime
Date creationDateTime

 The date and time when the cluster step was created.
 


startDateTime
Date startDateTime

 The date and time when the cluster step execution started.
 


endDateTime
Date endDateTime

 The date and time when the cluster step execution completed or failed.
 








Class com.amazonaws.services.elasticmapreduce.model.SupportedProductConfig extends Object implements Serializable




Serialized Fields


name
String name

 The name of the product configuration.
 


args
com.amazonaws.internal.SdkInternalList<T> args

 The list of user-supplied arguments.
 








Class com.amazonaws.services.elasticmapreduce.model.Tag extends Object implements Serializable




Serialized Fields


key
String key

 A user-defined key, which is the minimum required information for a valid
 tag. For more information, see Tagging Amazon EMR Resources.
 


value
String value

 A user-defined value, which is optional in a tag. For more information,
 see Tagging Amazon EMR Resources.
 








Class com.amazonaws.services.elasticmapreduce.model.TerminateJobFlowsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobFlowIds
com.amazonaws.internal.SdkInternalList<T> jobFlowIds

 A list of job flows to be shutdown.
 








Class com.amazonaws.services.elasticmapreduce.model.VolumeSpecification extends Object implements Serializable




Serialized Fields


volumeType
String volumeType

 The volume type. Volume types supported are gp2, io1, standard.
 


iops
Integer iops

 The number of I/O operations per second (IOPS) that the volume supports.
 


sizeInGB
Integer sizeInGB

 The volume size, in gibibytes (GiB). This can be a number from 1 – 1024.
 If the volume type is EBS-optimized, the minimum value is 10.
 








Package com.amazonaws.services.elasticsearch.model




Class com.amazonaws.services.elasticsearch.model.AccessPoliciesStatus extends Object implements Serializable




Serialized Fields


options
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.
 


status
OptionStatus status

 The status of the access policy for the Elasticsearch domain. See
 OptionStatus for the status information that's included.
 








Class com.amazonaws.services.elasticsearch.model.AddTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aRN
String aRN

 Specify the ARN for which you want to add the tags.
 


tagList
List<E> tagList

 List of Tag that need to be added for the Elasticsearch
 domain.
 








Class com.amazonaws.services.elasticsearch.model.AdvancedOptionsStatus extends Object implements Serializable




Serialized Fields


options
Map<K,V> options

 Specifies the status of advanced options for the specified Elasticsearch
 domain.
 


status
OptionStatus status

 Specifies the status of OptionStatus for advanced options
 for the specified Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.BaseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.CreateElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


domainName
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 elasticsearchClusterConfig

 Configuration options for an Elasticsearch domain. Specifies the instance
 type and number of instances in the domain cluster.
 


eBSOptions
EBSOptions eBSOptions

 Options to enable, disable and specify the type and size of EBS storage
 volumes.
 


accessPolicies
String accessPolicies

 IAM access policy as a JSON-formatted string.
 


snapshotOptions
SnapshotOptions snapshotOptions

 Option to set time, in UTC format, of the daily automated snapshot.
 Default value is 0 hours.
 


advancedOptions
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.
 








Class com.amazonaws.services.elasticsearch.model.CreateElasticsearchDomainResult extends Object implements Serializable




Serialized Fields


domainStatus
ElasticsearchDomainStatus domainStatus

 The status of the newly created Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.DeleteElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


domainName
String domainName

 The name of the Elasticsearch domain that you want to permanently delete.
 








Class com.amazonaws.services.elasticsearch.model.DeleteElasticsearchDomainResult extends Object implements Serializable




Serialized Fields


domainStatus
ElasticsearchDomainStatus domainStatus

 The status of the Elasticsearch domain being deleted.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainConfigRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


domainName
String domainName

 The Elasticsearch domain that you want to get information about.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainConfigResult extends Object implements Serializable




Serialized Fields


domainConfig
ElasticsearchDomainConfig domainConfig

 The configuration information of the domain requested in the
 DescribeElasticsearchDomainConfig request.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


domainName
String domainName

 The name of the Elasticsearch domain for which you want information.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainResult extends Object implements Serializable




Serialized Fields


domainStatus
ElasticsearchDomainStatus domainStatus

 The current status of the Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


domainNames
List<E> domainNames

 The Elasticsearch domains for which you want information.
 








Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainsResult extends Object implements Serializable




Serialized Fields


domainStatusList
List<E> domainStatusList

 The status of the domains requested in the
 DescribeElasticsearchDomains request.
 








Class com.amazonaws.services.elasticsearch.model.DisabledOperationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.DomainInfo extends Object implements Serializable




Serialized Fields


domainName
String domainName

 Specifies the DomainName.
 








Class com.amazonaws.services.elasticsearch.model.EBSOptions extends Object implements Serializable




Serialized Fields


eBSEnabled
Boolean eBSEnabled

 Specifies whether EBS-based storage is enabled.
 


volumeType
String volumeType

 Specifies the volume type for EBS-based storage.
 


volumeSize
Integer volumeSize

 Integer to specify the size of an EBS volume.
 


iops
Integer iops

 Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).
 








Class com.amazonaws.services.elasticsearch.model.EBSOptionsStatus extends Object implements Serializable




Serialized Fields


options
EBSOptions options

 Specifies the EBS options for the specified Elasticsearch domain.
 


status
OptionStatus status

 Specifies the status of the EBS options for the specified Elasticsearch
 domain.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchClusterConfig extends Object implements Serializable




Serialized Fields


instanceType
String instanceType

 The instance type for an Elasticsearch cluster.
 


instanceCount
Integer instanceCount

 The number of instances in the specified domain cluster.
 


dedicatedMasterEnabled
Boolean dedicatedMasterEnabled

 A boolean value to indicate whether a dedicated master node is enabled.
 See About Dedicated Master Nodes for more information.
 


zoneAwarenessEnabled
Boolean zoneAwarenessEnabled

 A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
 


dedicatedMasterType
String dedicatedMasterType

 The instance type for a dedicated master node.
 


dedicatedMasterCount
Integer dedicatedMasterCount

 Total number of dedicated master nodes, active and on standby, for the
 cluster.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchClusterConfigStatus extends Object implements Serializable




Serialized Fields


options
ElasticsearchClusterConfig options

 Specifies the cluster configuration for the specified Elasticsearch
 domain.
 


status
OptionStatus status

 Specifies the status of the configuration for the specified Elasticsearch
 domain.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchDomainConfig extends Object implements Serializable




Serialized Fields


elasticsearchClusterConfig
ElasticsearchClusterConfigStatus elasticsearchClusterConfig

 Specifies the ElasticsearchClusterConfig for the
 Elasticsearch domain.
 


eBSOptions
EBSOptionsStatus eBSOptions

 Specifies the EBSOptions for the Elasticsearch domain.
 


accessPolicies
AccessPoliciesStatus accessPolicies

 IAM access policy as a JSON-formatted string.
 


snapshotOptions
SnapshotOptionsStatus snapshotOptions

 Specifies the SnapshotOptions for the Elasticsearch domain.
 


advancedOptions
AdvancedOptionsStatus advancedOptions

 Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
 








Class com.amazonaws.services.elasticsearch.model.ElasticsearchDomainStatus extends Object implements Serializable




Serialized Fields


domainId
String domainId

 The unique identifier for the specified Elasticsearch domain.
 


domainName
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).
 


aRN
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.
 


created
Boolean created

 The domain creation status. True if the creation of an
 Elasticsearch domain is complete. False if domain creation
 is still in progress.
 


deleted
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.
 


endpoint
String endpoint

 The Elasticsearch domain endpoint that you use to submit index and search
 requests.
 


processing
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 elasticsearchClusterConfig

 The type and number of instances in the domain cluster.
 


eBSOptions
EBSOptions eBSOptions

 The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
 


accessPolicies
String accessPolicies

 IAM access policy as a JSON-formatted string.
 


snapshotOptions
SnapshotOptions snapshotOptions

 Specifies the status of the SnapshotOptions
 


advancedOptions
Map<K,V> advancedOptions

 Specifies the status of the AdvancedOptions
 








Class com.amazonaws.services.elasticsearch.model.InternalException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.InvalidTypeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.ListDomainNamesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.elasticsearch.model.ListDomainNamesResult extends Object implements Serializable




Serialized Fields


domainNames
List<E> domainNames

 List of Elasticsearch domain names.
 








Class com.amazonaws.services.elasticsearch.model.ListTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aRN
String aRN

 Specify the ARN for the Elasticsearch domain to which the
 tags are attached that you want to view.
 








Class com.amazonaws.services.elasticsearch.model.ListTagsResult extends Object implements Serializable




Serialized Fields


tagList
List<E> tagList

 List of Tag for the requested Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.OptionStatus extends Object implements Serializable




Serialized Fields


creationDate
Date creationDate

 Timestamp which tells the creation date for the entity.
 


updateDate
Date updateDate

 Timestamp which tells the last updated time for the entity.
 


updateVersion
Integer updateVersion

 Specifies the latest version for the entity.
 


state
String state

 Provides the OptionState for the Elasticsearch domain.
 


pendingDeletion
Boolean pendingDeletion

 Indicates whether the Elasticsearch domain is being deleted.
 








Class com.amazonaws.services.elasticsearch.model.RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aRN
String aRN

 Specifies the ARN for the Elasticsearch domain from which
 you want to delete the specified tags.
 


tagKeys
List<E> tagKeys

 Specifies the TagKey list which you want to remove from the
 Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elasticsearch.model.SnapshotOptions extends Object implements Serializable




Serialized Fields


automatedSnapshotStartHour
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.
 








Class com.amazonaws.services.elasticsearch.model.SnapshotOptionsStatus extends Object implements Serializable




Serialized Fields


options
SnapshotOptions options

 Specifies the daily snapshot options specified for the Elasticsearch
 domain.
 


status
OptionStatus status

 Specifies the status of a daily automated snapshot.
 








Class com.amazonaws.services.elasticsearch.model.Tag extends Object implements Serializable




Serialized Fields


key
String key

 Specifies the TagKey, the name of the tag. Tag keys must be
 unique for the Elasticsearch domain to which they are attached.
 


value
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
 








Class com.amazonaws.services.elasticsearch.model.UpdateElasticsearchDomainConfigRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


domainName
String domainName

 The name of the Elasticsearch domain that you are updating.
 


elasticsearchClusterConfig
ElasticsearchClusterConfig elasticsearchClusterConfig

 The type and number of instances to instantiate for the domain cluster.
 


eBSOptions
EBSOptions eBSOptions

 Specify the type and size of the EBS volume that you want to use.
 


snapshotOptions
SnapshotOptions snapshotOptions

 Option to set the time, in UTC format, for the daily automated snapshot.
 Default value is 0 hours.
 


advancedOptions
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.
 


accessPolicies
String accessPolicies

 IAM access policy as a JSON-formatted string.
 








Class com.amazonaws.services.elasticsearch.model.UpdateElasticsearchDomainConfigResult extends Object implements Serializable




Serialized Fields


domainConfig
ElasticsearchDomainConfig domainConfig

 The status of the updated Elasticsearch domain.
 








Class com.amazonaws.services.elasticsearch.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.elastictranscoder.model




Class com.amazonaws.services.elastictranscoder.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.Artwork extends Object implements Serializable




Serialized Fields


inputKey
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.
 


maxWidth
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.
 


maxHeight
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.
 


sizingPolicy
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.
 
 


paddingPolicy
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.
 


albumArtFormat
String albumArtFormat

 The format of album art, if any. Valid formats are .jpg and
 .png.
 


encryption
Encryption encryption

 The encryption settings, if any, that you want Elastic Transcoder to
 apply to your artwork.
 








Class com.amazonaws.services.elastictranscoder.model.AudioCodecOptions extends Object implements Serializable




Serialized Fields


profile
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.
 
 


bitDepth
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.
 


bitOrder
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.
 


signed
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.
 








Class com.amazonaws.services.elastictranscoder.model.AudioParameters extends Object implements Serializable




Serialized Fields


codec
String codec

 The audio codec for the output file. Valid values include
 aac, flac, mp2, mp3,
 pcm, and vorbis.
 


sampleRate
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.
 


bitRate
String bitRate

 The bit rate of the audio stream in the output file, in kilobits/second.
 Enter an integer between 64 and 320, inclusive.
 


channels
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.
 


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 output
 1, 2, or auto  channels with no audio input:
 Audio omitted from the output
 1  channel with any input with audio: One track
 with one channel, downmixed if necessary
 2  channels with one track with one channel: One
 track with two identical channels
 2 or auto  channels with two tracks with one channel
 each: One track with two channels
 2 or auto  channels with one track with two
 channels: One track with two channels
 2  channels with one track with multiple
 channels: One track with two channels
 auto  channels with one track with one channel:
 One track with one channel
 auto  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 output
 1, 2, or auto  channels with no audio input:
 Audio omitted from the output
 1  channel with any input with audio: One track
 with one channel, downmixed if necessary
 2  channels with one track with one channel: Two
 tracks with one identical channel each
 2 or auto  channels with two tracks with one channel
 each: Two tracks with one channel each
 2 or auto  channels with one track with two
 channels: Two tracks with one channel each
 2  channels with one track with multiple
 channels: Two tracks with one channel each
 auto  channels with one track with one channel:
 One track with one channel
 auto  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 output
 1, 2, or auto  channels with no audio input:
 Audio omitted from the output
 1  channel with any input with audio: One track
 with one channel, downmixed if necessary, plus six MOS tracks
 2  channels with one track with one channel: Two
 tracks with one identical channel each, plus six MOS tracks
 2 or auto  channels with two tracks with one channel
 each: Two tracks with one channel each, plus six MOS tracks
 2 or auto  channels with one track with two
 channels: Two tracks with one channel each, plus six MOS tracks
 2  channels with one track with multiple
 channels: Two tracks with one channel each, plus six MOS tracks
 auto  channels with one track with one channel:
 One track with one channel, plus seven MOS tracks
 auto  channels with one track with multiple
 channels: Up to eight tracks with one channel each, plus MOS tracks
 until there are eight tracks in all
 


codecOptions
AudioCodecOptions 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.
 








Class com.amazonaws.services.elastictranscoder.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
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.
 








Class com.amazonaws.services.elastictranscoder.model.CancelJobResult extends Object implements Serializable




Class com.amazonaws.services.elastictranscoder.model.CaptionFormat extends Object implements Serializable




Serialized Fields


format
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
 
 
 


pattern
String pattern

 The prefix for caption filenames, in the form description-
 {language}, where:
 
 
 description is a description of the video.
 {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 encryption

 The encryption settings, if any, that you want Elastic Transcoder to
 apply to your caption formats.
 








Class com.amazonaws.services.elastictranscoder.model.Captions extends Object implements Serializable




Serialized Fields


mergePolicy
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.
 


captionSources
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.
 


captionFormats
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.
 








Class com.amazonaws.services.elastictranscoder.model.CaptionSource extends Object implements Serializable




Serialized Fields


key
String key

 The name of the sidecar caption file that you want Elastic Transcoder to
 include in the output file.
 


language
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.
 


timeOffset
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.
 


label
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 encryption

 The encryption settings, if any, that you want Elastic Transcoder to
 apply to your caption sources.
 








Class com.amazonaws.services.elastictranscoder.model.Clip extends Object implements Serializable




Serialized Fields


timeSpan
TimeSpan timeSpan

 Settings that determine when a clip begins and how long it lasts.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobOutput extends Object implements Serializable




Serialized Fields


key
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.
 


thumbnailPattern
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.
 
 If you specify a literal value and/or
 {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.
 


thumbnailEncryption
Encryption thumbnailEncryption

 The encryption settings, if any, that you want Elastic Transcoder to
 apply to your thumbnail.
 


rotate
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.
 


presetId
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.
 


segmentDuration
String segmentDuration

 (Outputs in Fragmented MP4 or MPEG-TS format
 only.If you specify a preset in 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.
 


watermarks
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.
 


albumArt
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.
 


composition
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 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 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.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobPlaylist extends Object implements Serializable




Serialized Fields


name
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.
 


format
String format

 The format of the output playlist. Valid formats include
 HLSv3, HLSv4, and Smooth.
 


outputKeys
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 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 playReadyDrm

 The DRM settings, if any, that you want Elastic Transcoder to apply to
 the output files associated with this playlist.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pipelineId
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.
 


input
JobInput input

 A section of the request body that provides information about the file
 that is being transcoded.
 


output
CreateJobOutput output


outputs
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.
 


outputKeyPrefix
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.
 


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.
 


userMetadata
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.
 








Class com.amazonaws.services.elastictranscoder.model.CreateJobResult extends Object implements Serializable




Serialized Fields


job
Job job

 A section of the response body that provides information about the job
 that is created.
 








Class com.amazonaws.services.elastictranscoder.model.CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
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.
 


inputBucket
String inputBucket

 The Amazon S3 bucket in which you saved the media files that you want to
 transcode.
 


outputBucket
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:
 

 You want to save transcoded files, thumbnails (if any), and playlists
 (if any) together in one bucket.
 You do not want to specify the users or groups who have access to the
 transcoded files, thumbnails, and playlists.
 You do not want to specify the permissions that Elastic Transcoder
 grants to the files. When Elastic Transcoder saves files in
 OutputBucket, it grants full control over the files only to
 the AWS account that owns the role that is specified by Role
 .
 You want to associate the transcoded files and thumbnails with the
 Amazon S3 Standard storage class.
 
 
 
 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.
 


role
String role

 The IAM Amazon Resource Name (ARN) for the role that you want Elastic
 Transcoder to use to create the pipeline.
 


awsKmsKeyArn
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 notifications

 The Amazon Simple Notification Service (Amazon SNS) topic that you want
 to notify to report job status.
 
 To receive notifications, you must also subscribe to the new
 topic in the Amazon SNS console.
 
 Progressing: The topic ARN for the Amazon Simple Notification
 Service (Amazon SNS) topic that you want to notify when Elastic
 Transcoder has started to process a job in this pipeline. This is the ARN
 that Amazon SNS returned when you created the topic. For more
 information, see Create a Topic in the Amazon Simple Notification Service
 Developer Guide.
 Completed: The topic ARN for the Amazon SNS topic that you
 want to notify when Elastic Transcoder has finished processing a job in
 this pipeline. This is the ARN that Amazon SNS returned when you created
 the topic.
 Warning: The topic ARN for the Amazon SNS topic that you want
 to notify when Elastic Transcoder encounters a warning condition while
 processing a job in this pipeline. This is the ARN that Amazon SNS
 returned when you created the topic.
 Error: The topic ARN for the Amazon SNS topic that you want to
 notify when Elastic Transcoder encounters an error condition while
 processing a job in this pipeline. This is the ARN that Amazon SNS
 returned when you created the topic.
 


contentConfig
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.
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic
 Transcoder to save transcoded files and playlists.
 Permissions (Optional): The Permissions object specifies which
 users you want to have access to transcoded 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 Type: Specify the type of value that appears in the
 Grantee object:
 
 Canonical: The value in the 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. A
 canonical user ID is not the same as an AWS account number.
 Email: The value in the Grantee object is the
 registered email address of an AWS account.
 Group: The value in the Grantee object is 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. 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
 Access: The permission that you want to give to the AWS user
 that you specified in 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.
 
 
 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.
 


thumbnailConfig
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.
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic
 Transcoder to save thumbnail files.
 Permissions (Optional): The 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.
 GranteeType: Specify the type of value that appears in the
 Grantee object:
 
 Canonical: The value in the Grantee object is
 either the canonical user ID for an AWS account or an origin access
 identity for an Amazon CloudFront distribution. A canonical
 user ID is not the same as an AWS account number.
 Email: The value in the Grantee object is the
 registered email address of an AWS account.
 Group: The value in the Grantee object is 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. 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.
 Access: The permission that you want to give to the AWS user
 that you specified in 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.
 
 
 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.
 








Class com.amazonaws.services.elastictranscoder.model.CreatePipelineResult extends Object implements Serializable




Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the
 pipeline that is created.
 


warnings
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.
 








Class com.amazonaws.services.elastictranscoder.model.CreatePresetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 The name of the preset. We recommend that the name be unique within the
 AWS account, but uniqueness is not enforced.
 


description
String description

 A description of the preset.
 


container
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.
 


video
VideoParameters video

 A section of the request body that specifies the video parameters.
 


audio
AudioParameters audio

 A section of the request body that specifies the audio parameters.
 


thumbnails
Thumbnails thumbnails

 A section of the request body that specifies the thumbnail parameters, if
 any.
 








Class com.amazonaws.services.elastictranscoder.model.CreatePresetResult extends Object implements Serializable




Serialized Fields


preset
Preset preset

 A section of the response body that provides information about the preset
 that is created.
 


warning
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.
 








Class com.amazonaws.services.elastictranscoder.model.DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The identifier of the pipeline that you want to delete.
 








Class com.amazonaws.services.elastictranscoder.model.DeletePipelineResult extends Object implements Serializable




Class com.amazonaws.services.elastictranscoder.model.DeletePresetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The identifier of the preset for which you want to get detailed
 information.
 








Class com.amazonaws.services.elastictranscoder.model.DeletePresetResult extends Object implements Serializable




Class com.amazonaws.services.elastictranscoder.model.DetectedProperties extends Object implements Serializable




Serialized Fields


width
Integer width

 The detected width of the input file, in pixels.
 


height
Integer height

 The detected height of the input file, in pixels.
 


frameRate
String frameRate

 The detected frame rate of the input file, in frames per second.
 


fileSize
Long fileSize

 The detected file size of the input file, in bytes.
 


durationMillis
Long durationMillis

 The detected duration of the input file, in milliseconds.
 








Class com.amazonaws.services.elastictranscoder.model.Encryption extends Object implements Serializable




Serialized Fields


mode
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.
 
 


key
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.
 


keyMd5
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.
 


initializationVector
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.
 








Class com.amazonaws.services.elastictranscoder.model.HlsContentProtection extends Object implements Serializable




Serialized Fields


method
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.
 


key
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.
 


keyMd5
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.
 


initializationVector
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.
 


licenseAcquisitionUrl
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.
 


keyStoragePolicy
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.
 








Class com.amazonaws.services.elastictranscoder.model.IncompatibleVersionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.Job extends Object implements Serializable




Serialized Fields


id
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.
 


arn
String arn

 The Amazon Resource Name (ARN) for the job.
 


pipelineId
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.
 


input
JobInput input

 A section of the request or response body that provides information about
 the file that is being transcoded.
 


output
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.
 
 
 Outputs recommended instead. A section of the
 request or response body that provides information about the transcoded
 (target) file.
 


outputs
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.
 


outputKeyPrefix
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.
 


playlists
com.amazonaws.internal.SdkInternalList<T> playlists

 Outputs in Fragmented MP4 or MPEG-TS format
 only.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.
 


status
String status

 The status of the job: Submitted, Progressing,
 Complete, Canceled, or Error.
 


userMetadata
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 timing

 Details about the timing of a job.
 








Class com.amazonaws.services.elastictranscoder.model.JobAlbumArt extends Object implements Serializable




Serialized Fields


mergePolicy
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.
 
 


artwork
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
 








Class com.amazonaws.services.elastictranscoder.model.JobInput extends Object implements Serializable




Serialized Fields


key
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.
 


frameRate
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.
 


resolution
String resolution

 This value must be auto, which causes Elastic Transcoder to
 automatically detect the resolution of the input file.
 


aspectRatio
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.
 


interlaced
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.
 


container
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 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 detectedProperties

 The detected properties of the input file.
 








Class com.amazonaws.services.elastictranscoder.model.JobOutput extends Object implements Serializable




Serialized Fields


id
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.
 


key
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.
 


thumbnailPattern
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.
 
 If you specify a literal value and/or
 {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.
 


thumbnailEncryption
Encryption thumbnailEncryption

 The encryption settings, if any, that you want Elastic Transcoder to
 apply to your thumbnail.
 


rotate
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.
 


presetId
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.
 


segmentDuration
String segmentDuration

 (Outputs in Fragmented MP4 or MPEG-TS format
 only.If you specify a preset in 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.
 


status
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.
 When 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 remains Progressing until all of the outputs reach a
 terminal status, either Complete or Error.
 When all of the outputs reach a terminal status,
 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.
 
 The value of Status is one of the following:
 Submitted, Progressing, Complete,
 Canceled, or Error.
 


statusDetail
String statusDetail

 Information that further explains Status.
 


duration
Long duration

 Duration of the output file, in seconds.
 


width
Integer width

 Specifies the width of the output file in pixels.
 


height
Integer height

 Height of the output file, in pixels.
 


frameRate
String frameRate

 Frame rate of the output file, in frames per second.
 


fileSize
Long fileSize

 File size of the output file, in bytes.
 


durationMillis
Long durationMillis

 Duration of the output file, in milliseconds.
 


watermarks
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.
 


albumArt
JobAlbumArt albumArt

 The album art to be associated with the output file, if any.
 


composition
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 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 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.
 


appliedColorSpaceConversion
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.
 








Class com.amazonaws.services.elastictranscoder.model.JobWatermark extends Object implements Serializable




Serialized Fields


presetWatermarkId
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.
 


inputKey
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 encryption

 The encryption settings, if any, that you want Elastic Transcoder to
 apply to your watermarks.
 








Class com.amazonaws.services.elastictranscoder.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pipelineId
String pipelineId

 The ID of the pipeline for which you want to get job information.
 


ascending
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.
 


pageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineResult extends Object implements Serializable




Serialized Fields


jobs
com.amazonaws.internal.SdkInternalList<T> jobs

 An array of Job objects that are in the specified pipeline.
 


nextPageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.ListJobsByStatusRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


status
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.
 


ascending
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.
 


pageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.ListJobsByStatusResult extends Object implements Serializable




Serialized Fields


jobs
com.amazonaws.internal.SdkInternalList<T> jobs

 An array of Job objects that have the specified status.
 


nextPageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.ListPipelinesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ascending
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.
 


pageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.ListPipelinesResult extends Object implements Serializable




Serialized Fields


pipelines
com.amazonaws.internal.SdkInternalList<T> pipelines

 An array of Pipeline objects.
 


nextPageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.ListPresetsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ascending
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.
 


pageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.ListPresetsResult extends Object implements Serializable




Serialized Fields


presets
com.amazonaws.internal.SdkInternalList<T> presets

 An array of Preset objects.
 


nextPageToken
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.
 








Class com.amazonaws.services.elastictranscoder.model.Notifications extends Object implements Serializable




Serialized Fields


progressing
String progressing

 The Amazon Simple Notification Service (Amazon SNS) topic that you want
 to notify when Elastic Transcoder has started to process the job.
 


completed
String completed

 The Amazon SNS topic that you want to notify when Elastic Transcoder has
 finished processing the job.
 


warning
String warning

 The Amazon SNS topic that you want to notify when Elastic Transcoder
 encounters a warning condition.
 


error
String error

 The Amazon SNS topic that you want to notify when Elastic Transcoder
 encounters an error condition.
 








Class com.amazonaws.services.elastictranscoder.model.Permission extends Object implements Serializable




Serialized Fields


granteeType
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. A canonical user ID is not the same as an AWS
 account number.
 Email: The registered email address of an AWS account.
 Group: One of the following predefined Amazon S3 groups:
 AllUsers, AuthenticatedUsers, or
 LogDelivery.
 
 


grantee
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.
 


access
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.
 
 








Class com.amazonaws.services.elastictranscoder.model.Pipeline extends Object implements Serializable




Serialized Fields


id
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.
 


arn
String arn

 The Amazon Resource Name (ARN) for the pipeline.
 


name
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
 


status
String status

 The current status of the pipeline:
 
 
 Active: The pipeline is processing jobs.
 Paused: The pipeline is not currently processing jobs.
 


inputBucket
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.
 


outputBucket
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.
 


role
String role

 The IAM Amazon Resource Name (ARN) for the role that Elastic Transcoder
 uses to transcode jobs for this pipeline.
 


awsKmsKeyArn
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 notifications

 The Amazon Simple Notification Service (Amazon SNS) topic that you want
 to notify to report job status.
 
 To receive notifications, you must also subscribe to the new
 topic in the Amazon SNS console.
 
 Progressing (optional): The Amazon Simple Notification Service
 (Amazon SNS) topic that you want to notify when Elastic Transcoder has
 started to process the job.
 Completed (optional): The Amazon SNS topic that you want to
 notify when Elastic Transcoder has finished processing the job.
 Warning (optional): The Amazon SNS topic that you want to
 notify when Elastic Transcoder encounters a warning condition.
 Error (optional): The Amazon SNS topic that you want to notify
 when Elastic Transcoder encounters an error condition.
 


contentConfig
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.
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic
 Transcoder to save transcoded files and playlists.
 Permissions: A list of the users and/or predefined Amazon S3
 groups you want to have access to transcoded files and playlists, and the
 type of access that you want them to have.
 
 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.
 
 
 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.
 
 
 
 
 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.
 


thumbnailConfig
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.
 
 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. A canonical user ID is not the same as an AWS
 account number.
 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.
 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.
 
 
 
 
 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.
 








Class com.amazonaws.services.elastictranscoder.model.PipelineOutputConfig extends Object implements Serializable




Serialized Fields


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:
 

 You want to save transcoded files, thumbnails (if any), and playlists
 (if any) together in one bucket.
 You do not want to specify the users or groups who have access to the
 transcoded files, thumbnails, and playlists.
 You do not want to specify the permissions that Elastic Transcoder
 grants to the files.
 You want to associate the transcoded files and thumbnails with the
 Amazon S3 Standard storage class.
 
 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.
 


storageClass
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.
 


permissions
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.
 








Class com.amazonaws.services.elastictranscoder.model.Playlist extends Object implements Serializable




Serialized Fields


name
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.
 


format
String format

 The format of the output playlist. Valid formats include
 HLSv3, HLSv4, and Smooth.
 


outputKeys
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 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 playReadyDrm

 The DRM settings, if any, that you want Elastic Transcoder to apply to
 the output files associated with this playlist.
 


status
String status

 The status of the job with which the playlist is associated.
 


statusDetail
String statusDetail

 Information that further explains the status.
 








Class com.amazonaws.services.elastictranscoder.model.PlayReadyDrm extends Object implements Serializable




Serialized Fields


format
String format

 The type of DRM, if any, that you want Elastic Transcoder to apply to the
 output files associated with this playlist.
 


key
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.
 


keyMd5
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.
 


keyId
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.
 


initializationVector
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.
 


licenseAcquisitionUrl
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:
 https://www.example.com/exampleKey/
 








Class com.amazonaws.services.elastictranscoder.model.Preset extends Object implements Serializable




Serialized Fields


id
String id

 Identifier for the new preset. You use this value to get settings for the
 preset or to delete it.
 


arn
String arn

 The Amazon Resource Name (ARN) for the preset.
 


name
String name

 The name of the preset.
 


description
String description

 A description of the preset.
 


container
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.
 


audio
AudioParameters audio

 A section of the response body that provides information about the audio
 preset values.
 


video
VideoParameters video

 A section of the response body that provides information about the video
 preset values.
 


thumbnails
Thumbnails thumbnails

 A section of the response body that provides information about the
 thumbnail preset values, if any.
 


type
String type

 Whether the preset is a default preset provided by Elastic Transcoder (
 System) or a preset that you have defined (
 Custom).
 








Class com.amazonaws.services.elastictranscoder.model.PresetWatermark extends Object implements Serializable




Serialized Fields


id
String id
A unique identifier for the settings for one watermark. The value of
 Id can be up to 40 characters long.


maxWidth
String maxWidth

 The maximum width of the watermark in one of the following formats:
 

 number of pixels (px): The minimum value is 16 pixels, and the
 maximum value is the value of MaxWidth.
 integer percentage (%): The range of valid values is 0 to 100. 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 calculation. If you specify the value in
 pixels, it must be less than or equal to the value of
 MaxWidth.
 
 


maxHeight
String maxHeight

 The maximum height of the watermark in one of the following formats:
 

 number of pixels (px): The minimum value is 16 pixels, and the
 maximum value is the value of MaxHeight.
 integer percentage (%): The range of valid values is 0 to 100. 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 calculation.
 
 If you specify the value in pixels, it must be less than or equal to the
 value of MaxHeight.
 


sizingPolicy
String sizingPolicy

 A value that controls scaling of the watermark:
 

 Fit: Elastic Transcoder scales the watermark so it matches the
 value that you specified in either MaxWidth or
 MaxHeight without exceeding the other value.
 Stretch: Elastic Transcoder stretches the watermark to match
 the values that you specified for MaxWidth and
 MaxHeight. If the relative proportions of the watermark and
 the values of MaxWidth and MaxHeight are
 different, the watermark will be distorted.
 ShrinkToFit: Elastic Transcoder scales the watermark 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 watermark up.
 
 


horizontalAlign
String horizontalAlign

 The horizontal position of the watermark unless you specify a non-zero
 value for HorizontalOffset:
 

 Left: The left edge of the watermark is aligned with the left
 border of the video.
 Right: The right edge of the watermark is aligned with the
 right border of the video.
 Center: The watermark is centered between the left and right
 borders.
 
 


horizontalOffset
String horizontalOffset

 The amount by which you want the horizontal position of the watermark to
 be offset from the position specified by HorizontalAlign:
 

 number of pixels (px): The minimum value is 0 pixels, and the maximum
 value is the value of MaxWidth.
 integer percentage (%): The range of valid values is 0 to 100.
 
 For example, if you specify Left for 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.
 


verticalAlign
String verticalAlign

 The vertical position of the watermark unless you specify a non-zero
 value for VerticalOffset:
 

 Top: The top edge of the watermark is aligned with the top
 border of the video.
 Bottom: The bottom edge of the watermark is aligned with the
 bottom border of the video.
 Center: The watermark is centered between the top and bottom
 borders.
 
 


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:
 

 number of pixels (px): The minimum value is 0 pixels, and the maximum
 value is the value of MaxHeight.
 integer percentage (%): The range of valid values is 0 to 100.
 
 For example, if you specify 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.
 


opacity
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.
 


target
String target

 A value that determines how Elastic Transcoder interprets values that you
 specified for HorizontalOffset, VerticalOffset,
 MaxWidth, and MaxHeight:
 

 Content: 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.
 Frame: HorizontalOffset and
 VerticalOffset values are calculated based on the borders of
 the video including 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 including black bars added by Elastic Transcoder, if any.
 
 








Class com.amazonaws.services.elastictranscoder.model.ReadJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The identifier of the job for which you want to get detailed information.
 








Class com.amazonaws.services.elastictranscoder.model.ReadJobResult extends Object implements Serializable




Serialized Fields


job
Job job

 A section of the response body that provides information about the job.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPipelineRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The identifier of the pipeline to read.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPipelineResult extends Object implements Serializable




Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the
 pipeline.
 


warnings
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.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPresetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The identifier of the preset for which you want to get detailed
 information.
 








Class com.amazonaws.services.elastictranscoder.model.ReadPresetResult extends Object implements Serializable




Serialized Fields


preset
Preset preset

 A section of the response body that provides information about the
 preset.
 








Class com.amazonaws.services.elastictranscoder.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.TestRoleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


role
String role

 The IAM Amazon Resource Name (ARN) for the role that you want Elastic
 Transcoder to test.
 


inputBucket
String inputBucket

 The Amazon S3 bucket that contains media files to be transcoded. The
 action attempts to read from this bucket.
 


outputBucket
String outputBucket

 The Amazon S3 bucket that Elastic Transcoder will write transcoded media
 files to. The action attempts to read from this bucket.
 


topics
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.
 








Class com.amazonaws.services.elastictranscoder.model.TestRoleResult extends Object implements Serializable




Serialized Fields


success
String success

 If the operation is successful, this value is true;
 otherwise, the value is false.
 


messages
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.
 








Class com.amazonaws.services.elastictranscoder.model.Thumbnails extends Object implements Serializable




Serialized Fields


format
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.
 


interval
String interval

 The approximate number of seconds between thumbnails. Specify an integer
 value.
 


resolution
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.
 


aspectRatio
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.
 


maxWidth
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.
 


maxHeight
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.
 


sizingPolicy
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.
 
 


paddingPolicy
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.
 








Class com.amazonaws.services.elastictranscoder.model.TimeSpan extends Object implements Serializable




Serialized Fields


startTime
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.
 


duration
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.
 








Class com.amazonaws.services.elastictranscoder.model.Timing extends Object implements Serializable




Serialized Fields


submitTimeMillis
Long submitTimeMillis

 The time the job was submitted to Elastic Transcoder, in epoch
 milliseconds.
 


startTimeMillis
Long startTimeMillis

 The time the job began transcoding, in epoch milliseconds.
 


finishTimeMillis
Long finishTimeMillis

 The time the job finished transcoding, in epoch milliseconds.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The identifier of the pipeline for which you want to change notification
 settings.
 


notifications
Notifications notifications

 The topic ARN for the Amazon Simple Notification Service (Amazon SNS)
 topic that you want to notify to report job status.
 
 To receive notifications, you must also subscribe to the new
 topic in the Amazon SNS console.
 
 Progressing: The topic ARN for the Amazon Simple Notification
 Service (Amazon SNS) topic that you want to notify when Elastic
 Transcoder has started to process jobs that are added to this pipeline.
 This is the ARN that Amazon SNS returned when you created the topic.
 Completed: The topic ARN for the Amazon SNS topic that you
 want to notify when Elastic Transcoder has finished processing a job.
 This is the ARN that Amazon SNS returned when you created the topic.
 Warning: The topic ARN for the Amazon SNS topic that you want
 to notify when Elastic Transcoder encounters a warning condition. This is
 the ARN that Amazon SNS returned when you created the topic.
 Error: The topic ARN for the Amazon SNS topic that you want to
 notify when Elastic Transcoder encounters an error condition. This is the
 ARN that Amazon SNS returned when you created the topic.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsResult extends Object implements Serializable




Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the
 pipeline.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The ID of the pipeline that you want to update.
 


name
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
 


inputBucket
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.
 


role
String role

 The IAM Amazon Resource Name (ARN) for the role that you want Elastic
 Transcoder to use to transcode jobs for this pipeline.
 


awsKmsKeyArn
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 notifications


contentConfig
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.
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic
 Transcoder to save transcoded files and playlists.
 Permissions (Optional): The Permissions object specifies which
 users you want to have access to transcoded 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 Type: Specify the type of value that appears in the
 Grantee object:
 
 Canonical: The value in the 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. A
 canonical user ID is not the same as an AWS account number.
 Email: The value in the Grantee object is the
 registered email address of an AWS account.
 Group: The value in the Grantee object is 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. 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
 Access: The permission that you want to give to the AWS user
 that you specified in 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.
 
 
 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.
 


thumbnailConfig
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.
 
 
 Bucket: The Amazon S3 bucket in which you want Elastic
 Transcoder to save thumbnail files.
 Permissions (Optional): The 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.
 GranteeType: Specify the type of value that appears in the
 Grantee object:
 
 Canonical: The value in the Grantee object is
 either the canonical user ID for an AWS account or an origin access
 identity for an Amazon CloudFront distribution. A canonical
 user ID is not the same as an AWS account number.
 Email: The value in the Grantee object is the
 registered email address of an AWS account.
 Group: The value in the Grantee object is 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. 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.
 Access: The permission that you want to give to the AWS user
 that you specified in 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.
 
 
 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.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineResult extends Object implements Serializable




Serialized Fields


pipeline
Pipeline pipeline


warnings
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.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineStatusRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


id
String id

 The identifier of the pipeline to update.
 


status
String status

 The desired status of the pipeline:
 
 
  Active: The pipeline is processing jobs.
  Paused: The pipeline is not currently processing jobs.
 








Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineStatusResult extends Object implements Serializable




Serialized Fields


pipeline
Pipeline pipeline

 A section of the response body that provides information about the
 pipeline.
 








Class com.amazonaws.services.elastictranscoder.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.elastictranscoder.model.VideoParameters extends Object implements Serializable




Serialized Fields


codec
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.
 


codecOptions
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.)
 
 
 1 - 396
 1b - 396
 1.1 - 900
 1.2 - 2376
 1.3 - 2376
 2 - 2376
 2.1 - 4752
 2.2 - 8100
 3 - 8100
 3.1 - 18000
 3.2 - 20480
 4 - 32768
 4.1 - 32768
 
 
 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:
 
 
 Standard to HD, 720x480 to 1920x1080 - Elastic Transcoder
 applies Bt601ToBt709
 Standard to HD, 720x576 to 1920x1080 - Elastic Transcoder
 applies Bt601ToBt709
 HD to Standard, 1920x1080 to 720x480 - Elastic Transcoder
 applies Bt709ToBt601
 HD to Standard, 1920x1080 to 720x576 - Elastic Transcoder
 applies Bt709ToBt601
 
 Elastic Transcoder may change the behavior of the
 ColorspaceConversionMode Auto mode in the
 future. All outputs in a playlist must use the same
 ColorSpaceConversionMode.
 
 If you do not specify a ColorSpaceConversionMode, Elastic
 Transcoder does not change the color space of a file. If you are unsure
 what ColorSpaceConversionMode was applied to your output
 file, you can check the AppliedColorSpaceConversion
 parameter included in your job response. If your job does not have an
 AppliedColorSpaceConversion in its response, no
 ColorSpaceConversionMode was applied.
 
 
 ChromaSubsampling
 
 
 The sampling pattern for the chroma (color) channels of the output video.
 Valid values include yuv420p and yuv422p.
 
 
 yuv420p samples the chroma information of every other
 horizontal and every other vertical line, yuv422p samples
 the color information of every horizontal line and every other vertical
 line.
 
 
 LoopCount (Gif Only)
 
 
 The number of times you want the output gif to loop. Valid values include
 Infinite and integers between 0 and
 100, inclusive.
 


keyframesMaxDist
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.
 


fixedGOP
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.
 
 


bitRate
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)
 
 
 1 - 64 : 80
 1b - 128 : 160
 1.1 - 192 : 240
 1.2 - 384 : 480
 1.3 - 768 : 960
 2 - 2000 : 2500
 3 - 10000 : 12500
 3.1 - 14000 : 17500
 3.2 - 20000 : 25000
 4 - 20000 : 25000
 4.1 - 50000 : 62500
 


frameRate
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:
 
 
 width in pixels and height in pixels represent the
 Resolution of the output video.
 maximum recommended decoding speed in Luma samples/second is
 less than or equal to the maximum value listed in the following table,
 based on the value that you specified for Level.
 
 
 The maximum recommended decoding speed in Luma samples/second for each
 level is described in the following list (Level - Decoding speed):
 
 
 1 - 380160
 1b - 380160
 1.1 - 76800
 1.2 - 1536000
 1.3 - 3041280
 2 - 3041280
 2.1 - 5068800
 2.2 - 5184000
 3 - 10368000
 3.1 - 27648000
 3.2 - 55296000
 4 - 62914560
 4.1 - 62914560
 


maxFrameRate
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.
 


resolution
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:
 
 
 The width must be an even integer between 128 and 4096, inclusive.
 The height must be an even integer between 96 and 3072, inclusive.
 If you specify a resolution that is less than the resolution of the
 input file, Elastic Transcoder rescales the output file to the lower
 resolution.
 If you specify a resolution that is greater than the resolution of
 the input file, Elastic Transcoder rescales the output to the higher
 resolution.
 We recommend that you specify a resolution for which the product of
 width and height is less than or equal to the applicable value in the
 following list (List - Max width x height value):
 
 1 - 25344
 1b - 25344
 1.1 - 101376
 1.2 - 101376
 1.3 - 101376
 2 - 101376
 2.1 - 202752
 2.2 - 404720
 3 - 404720
 3.1 - 921600
 3.2 - 1310720
 4 - 2097152
 4.1 - 2097152
 
 


aspectRatio
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.
 


maxWidth
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.
 


maxHeight
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.
 


displayAspectRatio
String displayAspectRatio

 The value that Elastic Transcoder adds to the metadata in the output
 file.
 


sizingPolicy
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.
 
 


paddingPolicy
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.
 


watermarks
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.
 








Class com.amazonaws.services.elastictranscoder.model.Warning extends Object implements Serializable




Serialized Fields


code
String code

 The code of the cross-regional warning.
 


message
String message

 The message explaining what resources are in a different region from the
 pipeline.
 
 
 Note: AWS KMS keys must be in the same region as the pipeline.
 








Package com.amazonaws.services.gamelift.model




Class com.amazonaws.services.gamelift.model.Alias extends Object implements Serializable




Serialized Fields


aliasId
String aliasId

 Unique identifier for a fleet alias.
 


name
String name

 Descriptive label associated with this alias. Alias names do not need to
 be unique.
 


description
String description

 Human-readable description of the alias.
 


routingStrategy
RoutingStrategy routingStrategy


creationTime
Date creationTime

 Time stamp indicating when this object was created. Format is an integer
 representing the number of seconds since the Unix epoch (Unix time).
 


lastUpdatedTime
Date lastUpdatedTime

 Time stamp indicating when this object was last modified. Format is an
 integer representing the number of seconds since the Unix epoch (Unix
 time).
 








Class com.amazonaws.services.gamelift.model.Build extends Object implements Serializable




Serialized Fields


buildId
String buildId

 Unique identifier for a build.
 


name
String name

 Descriptive label associated with this build. Build names do not need to
 be unique. It can be set using CreateBuild or UpdateBuild.
 


version
String version

 Version associated with this build. Version strings do not need to be
 unique to a build. This value can be set using CreateBuild or
 UpdateBuild.
 


status
String status

 Current status of the build. Possible build states include:
 

 INITIALIZED: A new build has been defined, but no files have been
 uploaded. You cannot create fleets for builds that are in this state.
 When a build is successfully created, the build state is set to this
 value.
 READY: The game build has been successfully uploaded. You can now
 create new fleets for this build.
 FAILED: The game build upload failed. You cannot create new fleets
 for this build.
 
 


sizeOnDisk
Long sizeOnDisk

 File size of the uploaded game build, expressed in bytes. When the build
 state is INITIALIZED, this value is 0.
 


creationTime
Date creationTime

 Time stamp indicating when this object was created. Format is an integer
 representing the number of seconds since the Unix epoch (Unix time).
 








Class com.amazonaws.services.gamelift.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 Descriptive label associated with this alias. Alias names do not need to
 be unique.
 


description
String description

 Human-readable description of the alias.
 


routingStrategy
RoutingStrategy routingStrategy

 Object specifying the fleet and routing type to use for the alias.
 








Class com.amazonaws.services.gamelift.model.CreateAliasResult extends Object implements Serializable




Serialized Fields


alias
Alias alias

 Object containing the newly created alias record.
 








Class com.amazonaws.services.gamelift.model.CreateBuildRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 Descriptive label associated with this build. Build names do not need to
 be unique. A build name can be changed later using UpdateBuild.
 


version
String version

 Version associated with this build. Version strings do not need to be
 unique to a build. A build version can be changed later using
 UpdateBuild.
 


storageLocation
S3Location storageLocation








Class com.amazonaws.services.gamelift.model.CreateBuildResult extends Object implements Serializable




Serialized Fields


build
Build build

 Set of properties for the newly created build.
 


uploadCredentials
Credentials uploadCredentials

 AWS credentials required when uploading a game build to the storage
 location. These credentials have a limited lifespan and are valid only
 for the build they were issued for. If you need to get fresh credentials,
 call RequestUploadCredentials.
 


storageLocation
S3Location storageLocation

 Amazon S3 path and key, identifying where the game build files are
 stored.
 








Class com.amazonaws.services.gamelift.model.CreateFleetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 Descriptive label associated with this fleet. Fleet names do not need to
 be unique.
 


description
String description

 Human-readable description of the fleet.
 


buildId
String buildId

 Unique identifier for the build you want the new fleet to use.
 


serverLaunchPath
String serverLaunchPath

 Path to the launch executable for the game server. A game server is built
 into a C:\game drive. This value must be expressed as
 C:\game\[launchpath]. Example: If, when built, your game
 server files are in a folder called "MyGame", your log path should be
 C:\game\MyGame\server.exe.
 


serverLaunchParameters
String serverLaunchParameters

 Parameters required to launch your game server. These parameters should
 be expressed as a string of command-line parameters. Example:
 "+sv_port 33435 +start_lobby".
 


logPaths
List<E> logPaths

 Path to game-session log files generated by your game server. Once a game
 session has been terminated, Amazon GameLift captures and stores the logs
 on Amazon S3. Use the GameLift console to access the stored logs.
 


eC2InstanceType
String eC2InstanceType

 Type of EC2 instances used in the fleet. EC2 instance types define the
 CPU, memory, storage, and networking capacity of the fleetaposs hosts.
 Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance
 Types for detailed descriptions of each.
 


eC2InboundPermissions
List<E> eC2InboundPermissions

 Access limits for incoming traffic. Setting these values limits game
 server access to incoming traffic using specified IP ranges and port
 numbers. Some ports in a range may be restricted. You can provide one or
 more sets of permissions for the fleet.
 


newGameSessionProtectionPolicy
String newGameSessionProtectionPolicy

 Game session protection policy to apply to all instances created in this
 fleet. If this parameter is not set, new instances in this fleet will
 default to no protection. Protection can be set for individual instances
 using UpdateGameSession.
 

 NoProtection: The game session can be terminated during a scale-down
 event.
 FullProtection: If the game session is in an ACTIVE status, it cannot
 be terminated during a scale-down event.
 
 








Class com.amazonaws.services.gamelift.model.CreateFleetResult extends Object implements Serializable




Serialized Fields


fleetAttributes
FleetAttributes fleetAttributes

 Properties for the newly created fleet.
 








Class com.amazonaws.services.gamelift.model.CreateGameSessionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for a fleet. Each request must reference either a fleet
 ID or alias ID, but not both.
 


aliasId
String aliasId

 Unique identifier for a fleet alias. Each request must reference either a
 fleet ID or alias ID, but not both.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 Maximum number of players that can be connected simultaneously to the
 game session.
 


name
String name

 Descriptive label associated with this game session. Session names do not
 need to be unique.
 


gameProperties
List<E> gameProperties

 Set of properties used to administer a game session. These properties are
 passed to your game server.
 








Class com.amazonaws.services.gamelift.model.CreateGameSessionResult extends Object implements Serializable




Serialized Fields


gameSession
GameSession gameSession

 Object containing the newly created game session record.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


gameSessionId
String gameSessionId

 Unique identifier for a game session. Specify the game session you want
 to add a player to.
 


playerId
String playerId

 Unique identifier for the player to be added.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionResult extends Object implements Serializable




Serialized Fields


playerSession
PlayerSession playerSession

 Object containing the newly created player session record.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


gameSessionId
String gameSessionId

 Unique identifier for a game session.
 


playerIds
List<E> playerIds

 List of unique identifiers for the players to be added.
 








Class com.amazonaws.services.gamelift.model.CreatePlayerSessionsResult extends Object implements Serializable




Serialized Fields


playerSessions
List<E> playerSessions

 Collection of player session objects created for the added players.
 








Class com.amazonaws.services.gamelift.model.Credentials extends Object implements Serializable




Serialized Fields


accessKeyId
String accessKeyId

 Access key for an AWS account.
 


secretAccessKey
String secretAccessKey

 Secret key for an AWS account.
 


sessionToken
String sessionToken

 Token specific to a build ID.
 








Class com.amazonaws.services.gamelift.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aliasId
String aliasId

 Unique identifier for a fleet alias. Specify the alias you want to
 delete.
 








Class com.amazonaws.services.gamelift.model.DeleteBuildRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


buildId
String buildId

 Unique identifier for the build you want to delete.
 








Class com.amazonaws.services.gamelift.model.DeleteFleetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the fleet you want to delete.
 








Class com.amazonaws.services.gamelift.model.DeleteScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 Descriptive label associated with this scaling policy. Policy names do
 not need to be unique.
 


fleetId
String fleetId

 Unique identifier for a fleet.
 








Class com.amazonaws.services.gamelift.model.DescribeAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aliasId
String aliasId

 Unique identifier for a fleet alias. Specify the alias you want to
 retrieve.
 








Class com.amazonaws.services.gamelift.model.DescribeAliasResult extends Object implements Serializable




Serialized Fields


alias
Alias alias

 Object containing the requested alias.
 








Class com.amazonaws.services.gamelift.model.DescribeBuildRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


buildId
String buildId

 Unique identifier for the build you want to retrieve properties for.
 








Class com.amazonaws.services.gamelift.model.DescribeBuildResult extends Object implements Serializable




Serialized Fields


build
Build build

 Set of properties describing the requested build.
 








Class com.amazonaws.services.gamelift.model.DescribeEC2InstanceLimitsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


eC2InstanceType
String eC2InstanceType

 Type of EC2 instances used in the fleet. EC2 instance types define the
 CPU, memory, storage, and networking capacity of the fleetaposs hosts.
 Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance
 Types for detailed descriptions of each. Leave this parameter blank
 to retrieve limits for all types.
 








Class com.amazonaws.services.gamelift.model.DescribeEC2InstanceLimitsResult extends Object implements Serializable




Serialized Fields


eC2InstanceLimits
List<E> eC2InstanceLimits

 Object containing the maximum number of instances for the specified
 instance type.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetAttributesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetIds
List<E> fleetIds

 Unique identifiers for the fleet(s) that you want to retrieve attributes
 for. Leave this parameter empty to retrieve attributes for all fleets.
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages. This
 parameter is ignored when the request specifies one or a list of fleet
 IDs.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value. This
 parameter is ignored when the request specifies one or a list of fleet
 IDs.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetAttributesResult extends Object implements Serializable




Serialized Fields


fleetAttributes
List<E> fleetAttributes

 Collection of objects containing attribute metadata for each requested
 fleet ID.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.DescribeFleetCapacityRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetIds
List<E> fleetIds

 Unique identifier for the fleet(s) you want to retrieve capacity
 information for.
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages. This
 parameter is ignored when the request specifies one or a list of fleet
 IDs.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value. This
 parameter is ignored when the request specifies one or a list of fleet
 IDs.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetCapacityResult extends Object implements Serializable




Serialized Fields


fleetCapacity
List<E> fleetCapacity

 Collection of objects containing capacity information for each requested
 fleet ID. Leave this parameter empty to retrieve capacity information for
 all fleets.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.DescribeFleetEventsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the fleet to get event logs for.
 


startTime
Date startTime

 Earliest date to retrieve event logs for. If no start time is specified,
 this call returns entries starting from when the fleet was created to the
 specified end time. Format is an integer representing the number of
 seconds since the Unix epoch (Unix time).
 


endTime
Date endTime

 Most recent date to retrieve event logs for. If no end time is specified,
 this call returns entries from the specified start time up to the
 present. Format is an integer representing the number of seconds since
 the Unix epoch (Unix time).
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetEventsResult extends Object implements Serializable




Serialized Fields


events
List<E> events

 Collection of objects containing event log entries for the specified
 fleet.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.DescribeFleetPortSettingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the fleet you want to retrieve port settings for.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetPortSettingsResult extends Object implements Serializable




Serialized Fields


inboundPermissions
List<E> inboundPermissions

 Object containing port settings for the requested fleet ID.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetUtilizationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetIds
List<E> fleetIds

 Unique identifier for the fleet(s) you want to retrieve utilization data
 for. Leave this parameter empty to retrieve utilization data for all
 fleets.
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages. This
 parameter is ignored when the request specifies one or a list of fleet
 IDs.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value. This
 parameter is ignored when the request specifies one or a list of fleet
 IDs.
 








Class com.amazonaws.services.gamelift.model.DescribeFleetUtilizationResult extends Object implements Serializable




Serialized Fields


fleetUtilization
List<E> fleetUtilization

 Collection of objects containing utilization information for each
 requested fleet ID.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionDetailsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for a fleet. Specify a fleet to retrieve information on
 all game sessions active on the fleet.
 


gameSessionId
String gameSessionId

 Unique identifier for a game session. Specify the game session to
 retrieve information on.
 


aliasId
String aliasId

 Unique identifier for a fleet alias. Specify an alias to retrieve
 information on all game sessions active on the fleet.
 


statusFilter
String statusFilter

 Game session status to filter results on. Possible game session states
 include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are
 transitory).
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionDetailsResult extends Object implements Serializable




Serialized Fields


gameSessionDetails
List<E> gameSessionDetails

 Collection of objects containing game session properties and the
 protection policy currently in force for each session matching the
 request.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for a fleet. Specify a fleet to retrieve information on
 all game sessions active on the fleet.
 


gameSessionId
String gameSessionId

 Unique identifier for a game session. Specify the game session to
 retrieve information on.
 


aliasId
String aliasId

 Unique identifier for a fleet alias. Specify an alias to retrieve
 information on all game sessions active on the fleet.
 


statusFilter
String statusFilter

 Game session status to filter results on. Possible game session states
 include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are
 transitory).
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeGameSessionsResult extends Object implements Serializable




Serialized Fields


gameSessions
List<E> gameSessions

 Collection of objects containing game session properties for each session
 matching the request.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.DescribePlayerSessionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


gameSessionId
String gameSessionId

 Unique identifier for a game session.
 


playerId
String playerId

 Unique identifier for a player.
 


playerSessionId
String playerSessionId

 Unique identifier for a player session.
 


playerSessionStatusFilter
String playerSessionStatusFilter

 Player session status to filter results on. Possible player session
 states include:
 

 RESERVED: The player session request has been received, but the
 player has not yet connected to the game server and/or been validated.
 ACTIVE: The player has been validated by the game server and is
 currently connected.
 COMPLETED: The player connection has been dropped.
 TIMEDOUT: A player session request was received, but the player did
 not connect and/or was not validated within the time-out limit (60
 seconds).
 
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages. If a player
 session ID is specified, this parameter is ignored.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value. If a player
 session ID is specified, this parameter is ignored.
 








Class com.amazonaws.services.gamelift.model.DescribePlayerSessionsResult extends Object implements Serializable




Serialized Fields


playerSessions
List<E> playerSessions

 Collection of objects containing properties for each player session that
 matches the request.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.DescribeScalingPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for a fleet. Specify the fleet to retrieve scaling
 policies for.
 


statusFilter
String statusFilter

 Game session status to filter results on. A scaling policy is only in
 force when in an Active state.
 

 ACTIVE: The scaling policy is currently in force.
 UPDATEREQUESTED: A request to update the scaling policy has been
 received.
 UPDATING: A change is being made to the scaling policy.
 DELETEREQUESTED: A request to delete the scaling policy has been
 received.
 DELETING: The scaling policy is being deleted.
 DELETED: The scaling policy has been deleted.
 ERROR: An error occurred in creating the policy. It should be removed
 and recreated.
 
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.DescribeScalingPoliciesResult extends Object implements Serializable




Serialized Fields


scalingPolicies
List<E> scalingPolicies

 Collection of objects containing the scaling policies matching the
 request.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.EC2InstanceCounts extends Object implements Serializable




Serialized Fields


dESIRED
Integer dESIRED

 Ideal number of active instances in the fleet.
 


mINIMUM
Integer mINIMUM

 Minimum value allowed for the fleet's instance count.
 


mAXIMUM
Integer mAXIMUM

 Maximum value allowed for the fleet's instance count.
 


pENDING
Integer pENDING

 Number of instances in the fleet that are starting but not yet active.
 


aCTIVE
Integer aCTIVE

 Actual number of active instances in the fleet.
 


iDLE
Integer iDLE

 Number of active instances in the fleet that are not currently hosting a
 game session.
 


tERMINATING
Integer tERMINATING

 Number of instances in the fleet that are no longer active but haven't
 yet been terminated.
 








Class com.amazonaws.services.gamelift.model.EC2InstanceLimit extends Object implements Serializable




Serialized Fields


eC2InstanceType
String eC2InstanceType

 Type of EC2 instances used in the fleet. EC2 instance types define the
 CPU, memory, storage, and networking capacity of the fleetaposs hosts.
 Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance
 Types for detailed descriptions of each.
 


currentInstances
Integer currentInstances

 Number of instances of the specified type that are currently in use by
 this AWS account.
 


instanceLimit
Integer instanceLimit

 Number of instances allowed.
 








Class com.amazonaws.services.gamelift.model.Event extends Object implements Serializable




Serialized Fields


eventId
String eventId

 Unique identifier for a fleet event.
 


resourceId
String resourceId

 Unique identifier for the resource, such as a fleet ID.
 


eventCode
String eventCode

 Type of event being logged.
 


message
String message

 Additional information related to the event.
 


eventTime
Date eventTime

 Time stamp indicating when this event occurred. Format is an integer
 representing the number of seconds since the Unix epoch (Unix time).
 








Class com.amazonaws.services.gamelift.model.FleetAttributes extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for a fleet.
 


description
String description

 Human-readable description of the fleet.
 


name
String name

 Descriptive label associated with this fleet. Fleet names do not need to
 be unique.
 


creationTime
Date creationTime

 Time stamp indicating when this object was created. Format is an integer
 representing the number of seconds since the Unix epoch (Unix time).
 


terminationTime
Date terminationTime

 Time stamp indicating when this fleet was terminated. Format is an
 integer representing the number of seconds since the Unix epoch (Unix
 time).
 


status
String status

 Current status of the fleet. Possible fleet states include:
 

 NEW: A new fleet has been defined and hosts allocated.
 DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being
 set up with the game build, and new hosts are being started.
 ACTIVE: Hosts can now accept game sessions.
 ERROR: An error occurred when downloading, validating, building, or
 activating the fleet.
 DELETING: Hosts are responding to a delete fleet request.
 TERMINATED: The fleet no longer exists.
 
 


buildId
String buildId

 Unique identifier for a build.
 


serverLaunchPath
String serverLaunchPath

 Path to the launch executable for the game server. A game server is built
 into a C:\game drive. This value must be expressed as
 C:\game\[launchpath]. Example: If, when built, your game
 server files are in a folder called "MyGame", your log path should be
 C:\game\MyGame\server.exe.
 


serverLaunchParameters
String serverLaunchParameters

 Parameters required to launch your game server. These parameters should
 be expressed as a string of command-line parameters. Example:
 "+sv_port 33435 +start_lobby".
 


logPaths
List<E> logPaths

 Path to game-session log files generated by your game server. Once a game
 session has been terminated, Amazon GameLift captures and stores the logs
 on Amazon S3. Use the GameLift console to access the stored logs.
 


newGameSessionProtectionPolicy
String newGameSessionProtectionPolicy

 Type of game session protection to set for all new instances started in
 the fleet.
 

 NoProtection: The game session can be terminated during a scale-down
 event.
 FullProtection: If the game session is in an ACTIVE status, it cannot
 be terminated during a scale-down event.
 
 








Class com.amazonaws.services.gamelift.model.FleetCapacity extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for a fleet.
 


instanceType
String instanceType

 Type of EC2 instances used in the fleet. EC2 instance types define the
 CPU, memory, storage, and networking capacity of the fleetaposs hosts.
 Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance
 Types for detailed descriptions of each.
 


instanceCounts
EC2InstanceCounts instanceCounts

 Current status of fleet capacity.
 








Class com.amazonaws.services.gamelift.model.FleetCapacityExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.FleetUtilization extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for a fleet.
 


activeGameSessionCount
Integer activeGameSessionCount

 Number of active game sessions currently being hosted on fleet game
 servers.
 


currentPlayerSessionCount
Integer currentPlayerSessionCount

 Number of active player sessions currently being hosted on fleet game
 servers.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 Maximum players allowed across all game sessions currently hosted in the
 fleet.
 








Class com.amazonaws.services.gamelift.model.GameProperty extends Object implements Serializable




Serialized Fields


key
String key


value
String value








Class com.amazonaws.services.gamelift.model.GameSession extends Object implements Serializable




Serialized Fields


gameSessionId
String gameSessionId

 Unique identifier for a game session.
 


name
String name

 Descriptive label associated with this game session. Session names do not
 need to be unique.
 


fleetId
String fleetId

 Unique identifier for a fleet.
 


creationTime
Date creationTime

 Time stamp indicating when this object was created. Format is an integer
 representing the number of seconds since the Unix epoch (Unix time).
 


terminationTime
Date terminationTime

 Time stamp indicating when this fleet was terminated. Format is an
 integer representing the number of seconds since the Unix epoch (Unix
 time).
 


currentPlayerSessionCount
Integer currentPlayerSessionCount

 Number of players currently in the game session.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 Maximum number of players allowed in the game session.
 


status
String status

 Current status of the game session. A game session must be in an ACTIVE
 state to have player sessions.
 


gameProperties
List<E> gameProperties

 Set of custom properties for the game session.
 


ipAddress
String ipAddress

 IP address of the game session.
 


playerSessionCreationPolicy
String playerSessionCreationPolicy

 Indicates whether or not the game session is accepting new players.
 








Class com.amazonaws.services.gamelift.model.GameSessionDetail extends Object implements Serializable




Serialized Fields


gameSession
GameSession gameSession


protectionPolicy
String protectionPolicy

 Current status of protection for the game session.
 

 NoProtection: The game session can be terminated during a scale-down
 event.
 FullProtection: If the game session is in an ACTIVE status, it cannot
 be terminated during a scale-down event.
 
 








Class com.amazonaws.services.gamelift.model.GameSessionFullException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.GetGameSessionLogUrlRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


gameSessionId
String gameSessionId

 Unique identifier for a game session. Specify the game session you want
 to get logs for.
 








Class com.amazonaws.services.gamelift.model.GetGameSessionLogUrlResult extends Object implements Serializable




Serialized Fields


preSignedUrl
String preSignedUrl

 Location of the requested game session logs, available for download.
 








Class com.amazonaws.services.gamelift.model.InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.InvalidFleetStatusException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.InvalidGameSessionStatusException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.IpPermission extends Object implements Serializable




Serialized Fields


fromPort
Integer fromPort

 Starting value for a range of allowed port numbers.
 


toPort
Integer toPort

 Ending value for a range of allowed port numbers. Port numbers are
 end-inclusive. This value must be higher than FromPort.
 


ipRange
String ipRange

 Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "
 000.000.000.000/[subnet mask]
 " or optionally the shortened version "0.0.0.0/[subnet mask]
 ".
 


protocol
String protocol

 Network communication protocol used by the fleet.
 








Class com.amazonaws.services.gamelift.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


routingStrategyType
String routingStrategyType

 Type of routing to filter results on. Use this parameter to retrieve only
 aliases of a certain type. To retrieve all aliases, leave this parameter
 empty. Possible routing types include:
 

 SIMPLE: The alias resolves to one specific fleet. Use this type when
 routing to active fleets.
 TERMINAL: The alias does not resolve to a fleet but instead can be
 used to display a message to the user. A terminal alias throws a
 TerminalRoutingStrategyException with the RoutingStrategy message
 embedded.
 
 


name
String name

 Descriptive label associated with this alias. Alias names do not need to
 be unique.
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.ListAliasesResult extends Object implements Serializable




Serialized Fields


aliases
List<E> aliases

 Collection of alias records that match the list request.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.ListBuildsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


status
String status

 Build state to filter results on. Use this parameter to retrieve builds
 in a certain state. To retrieve all builds, leave this parameter empty.
 Possible build states include:
 

 INITIALIZED: A new build has been defined, but no files have been
 uploaded. You cannot create fleets for builds that are in this state.
 When a build is successfully created, the build state is set to this
 value.
 READY: The game build has been successfully uploaded. You can now
 create new fleets for this build.
 FAILED: The game build upload failed. You cannot create new fleets
 for this build.
 
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.ListBuildsResult extends Object implements Serializable




Serialized Fields


builds
List<E> builds

 Collection of build records that match the request.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.ListFleetsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


buildId
String buildId

 Unique identifier of the build to return fleets for. Use this parameter
 to return only fleets using the specified build. To retrieve all fleets,
 leave this parameter empty.
 


limit
Integer limit

 Maximum number of results to return. You can use this parameter with
 NextToken to get results as a set of sequential pages.
 


nextToken
String nextToken

 Token indicating the start of the next sequential page of results. Use
 the token that is returned with a previous call to this action. To
 specify the start of the result set, do not specify a value.
 








Class com.amazonaws.services.gamelift.model.ListFleetsResult extends Object implements Serializable




Serialized Fields


fleetIds
List<E> fleetIds

 Set of fleet IDs matching the list request. You can retrieve additional
 information about all returned fleets by passing this result set to a
 call to DescribeFleetAttributes, DescribeFleetCapacity, and
 DescribeFleetUtilization.
 


nextToken
String nextToken

 Token indicating where to resume retrieving results on the next call to
 this action. If no token is returned, these results represent the end of
 the list.
 
 
 
 If a request has a limit that exactly matches the number of remaining
 results, a token is returned even though there are no more results to
 retrieve.
 
 








Class com.amazonaws.services.gamelift.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.PlayerSession extends Object implements Serializable




Serialized Fields


playerSessionId
String playerSessionId

 Unique identifier for a player session.
 


playerId
String playerId

 Unique identifier for a player.
 


gameSessionId
String gameSessionId

 Unique identifier for a game session.
 


fleetId
String fleetId

 Unique identifier for a fleet.
 


creationTime
Date creationTime

 Time stamp indicating when this object was created. Format is an integer
 representing the number of seconds since the Unix epoch (Unix time).
 


terminationTime
Date terminationTime

 Time stamp indicating when this fleet was terminated. Format is an
 integer representing the number of seconds since the Unix epoch (Unix
 time).
 


status
String status

 Current status of the player session. Possible player session states
 include:
 

 RESERVED: The player session request has been received, but the
 player has not yet connected to the game server and/or been validated.
 ACTIVE: The player has been validated by the game server and is
 currently connected.
 COMPLETED: The player connection has been dropped.
 TIMEDOUT: A player session request was received, but the player did
 not connect and/or was not validated within the time-out limit (60
 seconds).
 
 


ipAddress
String ipAddress

 Game session IP address. All player sessions reference the game session
 location.
 








Class com.amazonaws.services.gamelift.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 Descriptive label associated with this scaling policy. Policy names do
 not need to be unique. A fleet can have only one scaling policy with the
 same name.
 


fleetId
String fleetId

 Unique identity for the fleet to scale with this policy.
 


scalingAdjustment
Integer scalingAdjustment

 Amount of adjustment to make, based on the scaling adjustment type.
 


scalingAdjustmentType
String scalingAdjustmentType

 Type of adjustment to make to a fleet's instance count (see
 FleetCapacity):
 

 ChangeInCapacity: add (or subtract) the scaling adjustment value from
 the current instance count. Positive values scale up while negative
 values scale down.
 ExactCapacity: set the instance count to the scaling adjustment
 value.
 PercentChangeInCapacity: increase or reduce the current instance
 count by the scaling adjustment, read as a percentage. Positive values
 scale up while negative values scale down; for example, a value of "-10"
 scales the fleet down by 10%.
 
 


threshold
Double threshold

 Metric value used to trigger a scaling event.
 


comparisonOperator
String comparisonOperator

 Comparison operator to use when measuring the metric against the
 threshold value.
 


evaluationPeriods
Integer evaluationPeriods

 Length of time (in minutes) the metric must be at or beyond the threshold
 before a scaling event is triggered.
 


metricName
String metricName

 Name of the Service-defined metric that is used to trigger an adjustment.
 

 ActivatingGameSessions: number of game sessions in the process of
 being created (game session status = ACTIVATING).
 ActiveGameSessions: number of game sessions currently running (game
 session status = ACTIVE).
 CurrentPlayerSessions: number of active or reserved player sessions
 (player session status = ACTIVE or RESERVED).
 AvailablePlayerSessions: number of player session slots currently
 available in active game sessions across the fleet, calculated by
 subtracting a game session's current player session count from its
 maximum player session count. This number includes game sessions that are
 not currently accepting players (game session PlayerSessionCreationPolicy
 = DENY_ALL).
 ActiveInstances: number of instances currently running a game
 session.
 IdleInstances: number of instances not currently running a game
 session.
 
 








Class com.amazonaws.services.gamelift.model.PutScalingPolicyResult extends Object implements Serializable




Serialized Fields


name
String name

 Descriptive label associated with this scaling policy. Policy names do
 not need to be unique.
 








Class com.amazonaws.services.gamelift.model.RequestUploadCredentialsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


buildId
String buildId

 Unique identifier for the build you want to get credentials for.
 








Class com.amazonaws.services.gamelift.model.RequestUploadCredentialsResult extends Object implements Serializable




Serialized Fields


uploadCredentials
Credentials uploadCredentials

 AWS credentials required when uploading a game build to the storage
 location. These credentials have a limited lifespan and are valid only
 for the build they were issued for.
 


storageLocation
S3Location storageLocation

 Amazon S3 path and key, identifying where the game build files are
 stored.
 








Class com.amazonaws.services.gamelift.model.ResolveAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aliasId
String aliasId

 Unique identifier for the alias you want to resolve.
 








Class com.amazonaws.services.gamelift.model.ResolveAliasResult extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Fleet ID associated with the requested alias.
 








Class com.amazonaws.services.gamelift.model.RoutingStrategy extends Object implements Serializable




Serialized Fields


type
String type

 Type of routing strategy. Possible routing types include:
 

 SIMPLE: The alias resolves to one specific fleet. Use this type when
 routing to active fleets.
 TERMINAL: The alias does not resolve to a fleet but instead can be
 used to display a message to the user. A terminal alias throws a
 TerminalRoutingStrategyException with the RoutingStrategy message
 embedded.
 
 


fleetId
String fleetId

 Unique identifier for a fleet.
 


message
String message

 Message text to be used with a terminal routing strategy.
 








Class com.amazonaws.services.gamelift.model.S3Location extends Object implements Serializable




Serialized Fields


bucket
String bucket

 Amazon S3 bucket identifier.
 


key
String key

 Amazon S3 bucket key.
 


roleArn
String roleArn








Class com.amazonaws.services.gamelift.model.ScalingPolicy extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identity for the fleet associated with this scaling policy.
 


name
String name

 Descriptive label associated with this scaling policy. Policy names do
 not need to be unique.
 


status
String status

 Current status of the scaling policy. The scaling policy is only in force
 when in an Active state.
 

 ACTIVE: The scaling policy is currently in force.
 UPDATEREQUESTED: A request to update the scaling policy has been
 received.
 UPDATING: A change is being made to the scaling policy.
 DELETEREQUESTED: A request to delete the scaling policy has been
 received.
 DELETING: The scaling policy is being deleted.
 DELETED: The scaling policy has been deleted.
 ERROR: An error occurred in creating the policy. It should be removed
 and recreated.
 
 


scalingAdjustment
Integer scalingAdjustment

 Amount of adjustment to make, based on the scaling adjustment type.
 


scalingAdjustmentType
String scalingAdjustmentType

 Type of adjustment to make to a fleet's instance count (see
 FleetCapacity):
 

 ChangeInCapacity: add (or subtract) the scaling adjustment value from
 the current instance count. Positive values scale up while negative
 values scale down.
 ExactCapacity: set the instance count to the scaling adjustment
 value.
 PercentChangeInCapacity: increase or reduce the current instance
 count by the scaling adjustment, read as a percentage. Positive values
 scale up while negative values scale down.
 
 


comparisonOperator
String comparisonOperator

 Comparison operator to use when measuring a metric against the threshold
 value.
 


threshold
Double threshold

 Metric value used to trigger a scaling event.
 


evaluationPeriods
Integer evaluationPeriods

 Length of time (in minutes) the metric must be at or beyond the threshold
 before a scaling event is triggered.
 


metricName
String metricName

 Name of the GameLift-defined metric that is used to trigger an
 adjustment.
 

 ActivatingGameSessions: number of game sessions in the process of
 being created (game session status = ACTIVATING).
 ActiveGameSessions: number of game sessions currently running (game
 session status = ACTIVE).
 CurrentPlayerSessions: number of active or reserved player sessions
 (player session status = ACTIVE or RESERVED).
 AvailablePlayerSessions: number of player session slots currently
 available in active game sessions across the fleet, calculated by
 subtracting a game session's current player session count from its
 maximum player session count. This number does include game sessions that
 are not currently accepting players (game session
 PlayerSessionCreationPolicy = DENY_ALL).
 ActiveInstances: number of instances currently running a game
 session.
 IdleInstances: number of instances not currently running a game
 session.
 
 








Class com.amazonaws.services.gamelift.model.TerminalRoutingStrategyException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.gamelift.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aliasId
String aliasId

 Unique identifier for a fleet alias. Specify the alias you want to
 update.
 


name
String name

 Descriptive label associated with this alias. Alias names do not need to
 be unique.
 


description
String description

 Human-readable description of the alias.
 


routingStrategy
RoutingStrategy routingStrategy

 Object specifying the fleet and routing type to use for the alias.
 








Class com.amazonaws.services.gamelift.model.UpdateAliasResult extends Object implements Serializable




Serialized Fields


alias
Alias alias

 Object containing the updated alias configuration.
 








Class com.amazonaws.services.gamelift.model.UpdateBuildRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


buildId
String buildId

 Unique identifier for the build you want to update.
 


name
String name

 Descriptive label associated with this build. Build names do not need to
 be unique.
 


version
String version

 Version associated with this build. Version strings do not need to be
 unique to a build.
 








Class com.amazonaws.services.gamelift.model.UpdateBuildResult extends Object implements Serializable




Serialized Fields


build
Build build

 Object containing the updated build record.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetAttributesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the fleet you want to update attribute metadata
 for.
 


name
String name

 Descriptive label associated with this fleet. Fleet names do not need to
 be unique.
 


description
String description

 Human-readable description of the fleet.
 


newGameSessionProtectionPolicy
String newGameSessionProtectionPolicy

 Game session protection policy to apply to all new instances created in
 this fleet. Instances that already exist will not be affected. You can
 set protection for individual instances using UpdateGameSession.
 

 NoProtection: The game session can be terminated during a scale-down
 event.
 FullProtection: If the game session is in an ACTIVE status, it cannot
 be terminated during a scale-down event.
 
 








Class com.amazonaws.services.gamelift.model.UpdateFleetAttributesResult extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the updated fleet.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetCapacityRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the fleet you want to update capacity for.
 


desiredInstances
Integer desiredInstances

 Number of EC2 instances you want this fleet to host.
 


minSize
Integer minSize

 Minimum value allowed for the fleet's instance count. Default if not set
 is 0.
 


maxSize
Integer maxSize

 Maximum value allowed for the fleet's instance count. Default if not set
 is 1.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetCapacityResult extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the updated fleet.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetPortSettingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the fleet you want to update port settings for.
 


inboundPermissionAuthorizations
List<E> inboundPermissionAuthorizations

 Collection of port settings to be added to the fleet record.
 


inboundPermissionRevocations
List<E> inboundPermissionRevocations

 Collection of port settings to be removed from the fleet record.
 








Class com.amazonaws.services.gamelift.model.UpdateFleetPortSettingsResult extends Object implements Serializable




Serialized Fields


fleetId
String fleetId

 Unique identifier for the updated fleet.
 








Class com.amazonaws.services.gamelift.model.UpdateGameSessionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


gameSessionId
String gameSessionId

 Unique identifier for a game session. Specify the game session you want
 to update.
 


maximumPlayerSessionCount
Integer maximumPlayerSessionCount

 Maximum number of players that can be simultaneously connected to the
 game session.
 


name
String name

 Descriptive label associated with this game session. Session names do not
 need to be unique.
 


playerSessionCreationPolicy
String playerSessionCreationPolicy

 Policy determining whether or not the game session accepts new players.
 


protectionPolicy
String protectionPolicy

 Game session protection policy to apply to this game session only.
 

 NoProtection: The game session can be terminated during a scale-down
 event.
 FullProtection: If the game session is in an ACTIVE status, it cannot
 be terminated during a scale-down event.
 
 








Class com.amazonaws.services.gamelift.model.UpdateGameSessionResult extends Object implements Serializable




Serialized Fields


gameSession
GameSession gameSession

 Object containing the updated game session metadata.
 








Package com.amazonaws.services.glacier.model




Class com.amazonaws.services.glacier.model.AbortMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


uploadId
String uploadId
The upload ID of the multipart upload to delete.








Class com.amazonaws.services.glacier.model.AbortVaultLockRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.AddTagsToVaultRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


tags
Map<K,V> tags
The tags to add to the vault. Each tag is composed of a key and a
 value. The value can be an empty string.








Class com.amazonaws.services.glacier.model.CompleteMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


uploadId
String uploadId
The upload ID of the multipart upload.


archiveSize
String archiveSize
The total size, in bytes, of the entire archive. This value should be
 the sum of all the sizes of the individual parts that you uploaded.


checksum
String checksum
The SHA256 tree hash of the entire archive. It is the tree hash of
 SHA256 tree hash of the individual parts. If the value you specify in
 the request does not match the SHA256 tree hash of the final assembled
 archive as computed by Amazon Glacier, Amazon Glacier returns an error
 and the request fails.








Class com.amazonaws.services.glacier.model.CompleteMultipartUploadResult extends Object implements Serializable




Serialized Fields


location
String location
The relative URI path of the newly added archive resource.


checksum
String checksum
The checksum of the archive computed by Amazon Glacier.


archiveId
String archiveId
The ID of the archive. This value is also included as part of the
 location.








Class com.amazonaws.services.glacier.model.CompleteVaultLockRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


lockId
String lockId
The lockId value is the lock ID obtained from a
 InitiateVaultLock request.








Class com.amazonaws.services.glacier.model.CreateVaultRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.CreateVaultResult extends Object implements Serializable




Serialized Fields


location
String location
The URI of the vault that was created.








Class com.amazonaws.services.glacier.model.DataRetrievalPolicy extends Object implements Serializable




Serialized Fields


rules
com.amazonaws.internal.ListWithAutoConstructFlag<T> rules
The policy rule. Although this is a list type, currently there must be
 only one rule, which contains a Strategy field and optionally a
 BytesPerHour field.








Class com.amazonaws.services.glacier.model.DataRetrievalRule extends Object implements Serializable




Serialized Fields


strategy
String strategy
The type of data retrieval policy to set. Valid values:
 BytesPerHour|FreeTier|None


bytesPerHour
Long bytesPerHour
The maximum number of bytes that can be retrieved in an hour. 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.








Class com.amazonaws.services.glacier.model.DeleteArchiveRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


archiveId
String archiveId
The ID of the archive to delete.








Class com.amazonaws.services.glacier.model.DeleteVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.DeleteVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.DeleteVaultRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.DescribeJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


jobId
String jobId
The ID of the job to describe.








Class com.amazonaws.services.glacier.model.DescribeJobResult extends Object implements Serializable




Serialized Fields


jobId
String jobId
An opaque string that identifies an Amazon Glacier job.


jobDescription
String jobDescription
The job description you provided when you initiated the job.


action
String action
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
 
 Constraints:

 Allowed Values: ArchiveRetrieval, InventoryRetrieval


archiveId
String archiveId
For an ArchiveRetrieval job, this is the archive ID requested for
 download. Otherwise, this field is null.


vaultARN
String vaultARN
The Amazon Resource Name (ARN) of the vault from which the archive
 retrieval was requested.


creationDate
String creationDate
The UTC date when the job was created. A string representation of ISO
 8601 date format, for example, "2012-03-20T17:03:43.221Z".


completed
Boolean completed
The job status. When a job is completed, you get the job's output.


statusCode
String statusCode
The status code can be InProgress, Succeeded, or Failed, and indicates
 the status of the job.
 
 Constraints:

 Allowed Values: InProgress, Succeeded, Failed


statusMessage
String statusMessage
A friendly message that describes the job status.


archiveSizeInBytes
Long archiveSizeInBytes
For an ArchiveRetrieval job, this is the size in bytes of the archive
 being requested for download. For the InventoryRetrieval job, the
 value is null.


inventorySizeInBytes
Long inventorySizeInBytes
For an InventoryRetrieval job, this is the size in bytes of the
 inventory requested for download. For the ArchiveRetrieval job, the
 value is null.


sNSTopic
String sNSTopic
An Amazon Simple Notification Service (Amazon SNS) topic that receives
 notification.


completionDate
String completionDate
The UTC time that the archive retrieval request completed. While the
 job is in progress, the value will be null.


sHA256TreeHash
String sHA256TreeHash
For an ArchiveRetrieval job, it is the checksum of the archive.
 Otherwise, the value is null.  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.
 


archiveSHA256TreeHash
String archiveSHA256TreeHash
The SHA256 tree hash of the entire archive for an archive retrieval.
 For inventory retrieval jobs, this field is null.


retrievalByteRange
String retrievalByteRange
The retrieved byte range for archive retrieval jobs in the form
 "StartByteValue-EndByteValue" If no range was specified
 in the archive retrieval, then the whole archive is retrieved and
 StartByteValue equals 0 and EndByteValue equals the size
 of the archive minus 1. For inventory retrieval jobs this field is
 null.


inventoryRetrievalParameters
InventoryRetrievalJobDescription inventoryRetrievalParameters
Parameters used for range inventory retrieval.








Class com.amazonaws.services.glacier.model.DescribeVaultOutput extends Object implements Serializable




Serialized Fields


vaultARN
String vaultARN
The Amazon Resource Name (ARN) of the vault.


vaultName
String vaultName
The name of the vault.


creationDate
String creationDate
The UTC date when the vault was created. A string representation of
 ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".


lastInventoryDate
String lastInventoryDate
The UTC date when Amazon Glacier completed the last vault inventory. A
 string representation of ISO 8601 date format, for example,
 "2012-03-20T17:03:43.221Z".


numberOfArchives
Long numberOfArchives
The number of archives in the vault as of the last inventory date.
 This field will return null if an inventory has not yet
 run on the vault, for example, if you just created the vault.


sizeInBytes
Long sizeInBytes
Total size, in bytes, of the archives in the vault as of the last
 inventory date. This field will return null if an inventory has not
 yet run on the vault, for example, if you just created the vault.








Class com.amazonaws.services.glacier.model.DescribeVaultRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.DescribeVaultResult extends Object implements Serializable




Serialized Fields


vaultARN
String vaultARN
The Amazon Resource Name (ARN) of the vault.


vaultName
String vaultName
The name of the vault.


creationDate
String creationDate
The UTC date when the vault was created. A string representation of
 ISO 8601 date format, for example, "2012-03-20T17:03:43.221Z".


lastInventoryDate
String lastInventoryDate
The UTC date when Amazon Glacier completed the last vault inventory. A
 string representation of ISO 8601 date format, for example,
 "2012-03-20T17:03:43.221Z".


numberOfArchives
Long numberOfArchives
The number of archives in the vault as of the last inventory date.
 This field will return null if an inventory has not yet
 run on the vault, for example, if you just created the vault.


sizeInBytes
Long sizeInBytes
Total size, in bytes, of the archives in the vault as of the last
 inventory date. This field will return null if an inventory has not
 yet run on the vault, for example, if you just created the vault.








Class com.amazonaws.services.glacier.model.GetDataRetrievalPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.








Class com.amazonaws.services.glacier.model.GetDataRetrievalPolicyResult extends Object implements Serializable




Serialized Fields


policy
DataRetrievalPolicy policy
Contains the returned data retrieval policy in JSON format.








Class com.amazonaws.services.glacier.model.GetJobOutputRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


jobId
String jobId
The job ID whose data is downloaded.


range
String range
The range of bytes to retrieve from the output. For example, if you
 want to download the first 1,048,576 bytes, specify "Range:
 bytes=0-1048575". By default, this operation downloads the entire
 output.








Class com.amazonaws.services.glacier.model.GetJobOutputResult extends Object implements Serializable




Serialized Fields


body
InputStream body
The job data, either archive data or inventory data.

 This stream must implement mark/reset in order for signature calculation to be performed
 before this data is read for the request payload.


checksum
String checksum
The checksum of the data in the response. This header is returned only
 when retrieving the output for an archive retrieval job. Furthermore,
 this header appears only under the following conditions:  You
 get the entire range of the archive.
 You request a range to
 return of the archive that starts and ends on a multiple of 1 MB. For
 example, if you have an 3.1 MB archive and you specify a range to
 return that starts at 1 MB and ends at 2 MB, then the
 x-amz-sha256-tree-hash is returned as a response header.
 You
 request a range of the archive to return that starts on a multiple of
 1 MB and goes to the end of the archive. For example, if you have a
 3.1 MB archive and you specify a range that starts at 2 MB and ends at
 3.1 MB (the end of the archive), then the x-amz-sha256-tree-hash is
 returned as a response header.
 


status
Integer status
The HTTP response code for a job output request. The value depends on
 whether a range was specified in the request.


contentRange
String contentRange
The range of bytes returned by Amazon Glacier. If only partial output
 is downloaded, the response provides the range of bytes Amazon Glacier
 returned. For example, bytes 0-1048575/8388608 returns the first 1 MB
 from 8 MB.


acceptRanges
String acceptRanges
Indicates the range units accepted. For more information, go to RFC2616.


contentType
String contentType
The Content-Type depends on whether the job output is an archive or a
 vault inventory. For archive data, the Content-Type is
 application/octet-stream. For vault inventory, if you requested CSV
 format when you initiated the job, the Content-Type is text/csv.
 Otherwise, by default, vault inventory is returned as JSON, and the
 Content-Type is application/json.


archiveDescription
String archiveDescription
The description of an archive.








Class com.amazonaws.services.glacier.model.GetVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.GetVaultAccessPolicyResult extends Object implements Serializable




Serialized Fields


policy
VaultAccessPolicy policy
Contains the returned vault access policy as a JSON string.








Class com.amazonaws.services.glacier.model.GetVaultLockRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.GetVaultLockResult extends Object implements Serializable




Serialized Fields


policy
String policy
The vault lock policy as a JSON string, which uses "\" as an escape
 character.


state
String state
The state of the vault lock. InProgress or
 Locked.


expirationDate
String expirationDate
The UTC date and time at which the lock ID expires. This value can be
 null if the vault lock is in a Locked state.


creationDate
String creationDate
The UTC date and time at which the vault lock was put into the
 InProgress state.








Class com.amazonaws.services.glacier.model.GetVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.GetVaultNotificationsResult extends Object implements Serializable




Serialized Fields


vaultNotificationConfig
VaultNotificationConfig vaultNotificationConfig
Returns the notification configuration set on the vault.








Class com.amazonaws.services.glacier.model.GlacierJobDescription extends Object implements Serializable




Serialized Fields


jobId
String jobId
An opaque string that identifies an Amazon Glacier job.


jobDescription
String jobDescription
The job description you provided when you initiated the job.


action
String action
The job type. It is either ArchiveRetrieval or InventoryRetrieval.
 
 Constraints:

 Allowed Values: ArchiveRetrieval, InventoryRetrieval


archiveId
String archiveId
For an ArchiveRetrieval job, this is the archive ID requested for
 download. Otherwise, this field is null.


vaultARN
String vaultARN
The Amazon Resource Name (ARN) of the vault from which the archive
 retrieval was requested.


creationDate
String creationDate
The UTC date when the job was created. A string representation of ISO
 8601 date format, for example, "2012-03-20T17:03:43.221Z".


completed
Boolean completed
The job status. When a job is completed, you get the job's output.


statusCode
String statusCode
The status code can be InProgress, Succeeded, or Failed, and indicates
 the status of the job.
 
 Constraints:

 Allowed Values: InProgress, Succeeded, Failed


statusMessage
String statusMessage
A friendly message that describes the job status.


archiveSizeInBytes
Long archiveSizeInBytes
For an ArchiveRetrieval job, this is the size in bytes of the archive
 being requested for download. For the InventoryRetrieval job, the
 value is null.


inventorySizeInBytes
Long inventorySizeInBytes
For an InventoryRetrieval job, this is the size in bytes of the
 inventory requested for download. For the ArchiveRetrieval job, the
 value is null.


sNSTopic
String sNSTopic
An Amazon Simple Notification Service (Amazon SNS) topic that receives
 notification.


completionDate
String completionDate
The UTC time that the archive retrieval request completed. While the
 job is in progress, the value will be null.


sHA256TreeHash
String sHA256TreeHash
For an ArchiveRetrieval job, it is the checksum of the archive.
 Otherwise, the value is null.  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.
 


archiveSHA256TreeHash
String archiveSHA256TreeHash
The SHA256 tree hash of the entire archive for an archive retrieval.
 For inventory retrieval jobs, this field is null.


retrievalByteRange
String retrievalByteRange
The retrieved byte range for archive retrieval jobs in the form
 "StartByteValue-EndByteValue" If no range was specified
 in the archive retrieval, then the whole archive is retrieved and
 StartByteValue equals 0 and EndByteValue equals the size
 of the archive minus 1. For inventory retrieval jobs this field is
 null.


inventoryRetrievalParameters
InventoryRetrievalJobDescription inventoryRetrievalParameters
Parameters used for range inventory retrieval.








Class com.amazonaws.services.glacier.model.InitiateJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


jobParameters
JobParameters jobParameters
Provides options for specifying job information.








Class com.amazonaws.services.glacier.model.InitiateJobResult extends Object implements Serializable




Serialized Fields


location
String location
The relative URI path of the job.


jobId
String jobId
The ID of the job.








Class com.amazonaws.services.glacier.model.InitiateMultipartUploadRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


archiveDescription
String archiveDescription
The archive description that you are uploading in parts. 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).


partSize
String partSize
The size of each part except the last, in bytes. The last part can be
 smaller than this part size.








Class com.amazonaws.services.glacier.model.InitiateMultipartUploadResult extends Object implements Serializable




Serialized Fields


location
String location
The relative URI path of the multipart upload ID Amazon Glacier
 created.


uploadId
String uploadId
The ID of the multipart upload. This value is also included as part of
 the location.








Class com.amazonaws.services.glacier.model.InitiateVaultLockRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


policy
VaultLockPolicy policy
The vault lock policy as a JSON string, which uses "\" as an escape
 character.








Class com.amazonaws.services.glacier.model.InitiateVaultLockResult extends Object implements Serializable




Serialized Fields


lockId
String lockId
The lock ID, which is used to complete the vault locking process.








Class com.amazonaws.services.glacier.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.InventoryRetrievalJobDescription extends Object implements Serializable




Serialized Fields


format
String format
The output format for the vault inventory list, which is set by the
 InitiateJob request when initiating a job to retrieve a vault
 inventory. Valid values are "CSV" and "JSON".


startDate
String startDate
The start of the date range in UTC for vault inventory retrieval that
 includes archives created on or after this date. A string
 representation of ISO 8601 date format, for example,
 2013-03-20T17:03:43Z.


endDate
String endDate
The end of the date range in UTC for vault inventory retrieval that
 includes archives created before this date. A string representation of
 ISO 8601 date format, for example, 2013-03-20T17:03:43Z.


limit
String limit
Specifies the maximum number of inventory items returned per vault
 inventory retrieval request. This limit is set when initiating the job
 with the a InitiateJob request.


marker
String marker
An opaque string that represents where to continue pagination of the
 vault inventory retrieval results. You use the marker in a new
 InitiateJob request to obtain additional inventory items. If
 there are no more inventory items, this value is null.
 For more information, see 
 Range Inventory Retrieval.








Class com.amazonaws.services.glacier.model.InventoryRetrievalJobInput extends Object implements Serializable




Serialized Fields


startDate
String startDate
The start of the date range in UTC for vault inventory retrieval that
 includes archives created on or after this date. A string
 representation of ISO 8601 date format, for example,
 2013-03-20T17:03:43Z.


endDate
String endDate
The end of the date range in UTC for vault inventory retrieval that
 includes archives created before this date. A string representation of
 ISO 8601 date format, for example, 2013-03-20T17:03:43Z.


limit
String limit
Specifies the maximum number of inventory items returned per vault
 inventory retrieval request. Valid values are greater than or equal to
 1.


marker
String marker
An opaque string that represents where to continue pagination of the
 vault inventory retrieval results. You use the marker in a new
 InitiateJob request to obtain additional inventory items. If
 there are no more inventory items, this value is null.








Class com.amazonaws.services.glacier.model.JobParameters extends Object implements Serializable




Serialized Fields


format
String format
When initiating a job to retrieve a vault inventory, you can
 optionally add this parameter to your request to specify the output
 format. If you are initiating an inventory job and do not specify a
 Format field, JSON is the default format. Valid values are "CSV" and
 "JSON".


type
String type
The job type. You can initiate a job to retrieve an archive or get an
 inventory of a vault. Valid values are "archive-retrieval" and
 "inventory-retrieval".


archiveId
String archiveId
The ID of the archive that you want to retrieve. This field is
 required only if Type is set to archive-retrieval. An
 error occurs if you specify this request parameter for an inventory
 retrieval job request.


description
String description
The optional description for the job. The description must be less
 than or equal to 1,024 bytes. The allowable characters are 7-bit ASCII
 without control codes-specifically, ASCII values 32-126 decimal or
 0x20-0x7E hexadecimal.


sNSTopic
String sNSTopic
The Amazon SNS topic ARN to which Amazon Glacier sends a notification
 when the job is completed and the output is ready for you to download.
 The specified topic publishes the notification to its subscribers. The
 SNS topic must exist.


retrievalByteRange
String retrievalByteRange
The byte range to retrieve for an archive retrieval. in the form
 "StartByteValue-EndByteValue" If not specified, the
 whole archive is retrieved. If specified, the byte range must be
 megabyte (1024*1024) aligned which means that StartByteValue
 must be divisible by 1 MB and EndByteValue plus 1 must be
 divisible by 1 MB or be the end of the archive specified as the
 archive byte size value minus 1. If RetrievalByteRange is not megabyte
 aligned, this operation returns a 400 response. An error occurs if
 you specify this field for an inventory retrieval job request.


inventoryRetrievalParameters
InventoryRetrievalJobInput inventoryRetrievalParameters
Input parameters used for range inventory retrieval.








Class com.amazonaws.services.glacier.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


limit
String limit
Specifies that the response be limited to the specified number of
 items or fewer. If not specified, the List Jobs operation returns up
 to 1,000 jobs.


marker
String marker
An opaque string used for pagination. This value specifies the job at
 which the listing of jobs should begin. Get the marker value from a
 previous List Jobs response. You need only include the marker if you
 are continuing the pagination of results started in a previous List
 Jobs request.


statuscode
String statuscode
Specifies the type of job status to return. You can specify the
 following values: "InProgress", "Succeeded", or "Failed".


completed
String completed
Specifies the state of the jobs to return. You can specify
 true or false.








Class com.amazonaws.services.glacier.model.ListJobsResult extends Object implements Serializable




Serialized Fields


jobList
com.amazonaws.internal.ListWithAutoConstructFlag<T> jobList
A list of job objects. Each job object contains metadata describing
 the job.


marker
String marker
An opaque string that represents where to continue pagination of the
 results. You use this value in a new List Jobs request to obtain more
 jobs in the list. If there are no more jobs, this value is
 null.








Class com.amazonaws.services.glacier.model.ListMultipartUploadsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


uploadIdMarker
String uploadIdMarker
An opaque string used for pagination. This value specifies the upload
 at which the listing of uploads should begin. Get the marker value
 from a previous List Uploads response. You need only include the
 marker if you are continuing the pagination of results started in a
 previous List Uploads request.


limit
String limit
Specifies the maximum number of uploads returned in the response body.
 If this value is not specified, the List Uploads operation returns up
 to 1,000 uploads.








Class com.amazonaws.services.glacier.model.ListMultipartUploadsResult extends Object implements Serializable




Serialized Fields


uploadsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> uploadsList
A list of in-progress multipart uploads.


marker
String marker
An opaque string that represents where to continue pagination of the
 results. You use the marker in a new List Multipart Uploads request to
 obtain more uploads in the list. If there are no more uploads, this
 value is null.








Class com.amazonaws.services.glacier.model.ListPartsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


uploadId
String uploadId
The upload ID of the multipart upload.


marker
String marker
An opaque string used for pagination. This value specifies the part at
 which the listing of parts should begin. Get the marker value from the
 response of a previous List Parts response. You need only include the
 marker if you are continuing the pagination of results started in a
 previous List Parts request.


limit
String limit
Specifies the maximum number of parts returned in the response body.
 If this value is not specified, the List Parts operation returns up to
 1,000 uploads.








Class com.amazonaws.services.glacier.model.ListPartsResult extends Object implements Serializable




Serialized Fields


multipartUploadId
String multipartUploadId
The ID of the upload to which the parts are associated.


vaultARN
String vaultARN
The Amazon Resource Name (ARN) of the vault to which the multipart
 upload was initiated.


archiveDescription
String archiveDescription
The description of the archive that was specified in the Initiate
 Multipart Upload request.


partSizeInBytes
Long partSizeInBytes
The part size in bytes.


creationDate
String creationDate
The UTC time at which the multipart upload was initiated.


parts
com.amazonaws.internal.ListWithAutoConstructFlag<T> parts
A list of the part sizes of the multipart upload.


marker
String marker
An opaque string that represents where to continue pagination of the
 results. You use the marker in a new List Parts request to obtain more
 jobs in the list. If there are no more parts, this value is
 null.








Class com.amazonaws.services.glacier.model.ListTagsForVaultRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.








Class com.amazonaws.services.glacier.model.ListTagsForVaultResult extends Object implements Serializable




Serialized Fields


tags
Map<K,V> tags
The tags attached to the vault. Each tag is composed of a key and a
 value.








Class com.amazonaws.services.glacier.model.ListVaultsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


marker
String marker
A string used for pagination. The marker specifies the vault ARN after
 which the listing of vaults should begin.


limit
String limit
The maximum number of items returned in the response. If you don't
 specify a value, the List Vaults operation returns up to 1,000 items.








Class com.amazonaws.services.glacier.model.ListVaultsResult extends Object implements Serializable




Serialized Fields


vaultList
com.amazonaws.internal.ListWithAutoConstructFlag<T> vaultList
List of vaults.


marker
String marker
The vault ARN at which to continue pagination of the results. You use
 the marker in another List Vaults request to obtain more vaults in the
 list.








Class com.amazonaws.services.glacier.model.MissingParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.PartListElement extends Object implements Serializable




Serialized Fields


rangeInBytes
String rangeInBytes
The byte range of a part, inclusive of the upper value of the range.


sHA256TreeHash
String sHA256TreeHash
The SHA256 tree hash value that Amazon Glacier calculated for the
 part. This field is never null.








Class com.amazonaws.services.glacier.model.PolicyEnforcedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.RemoveTagsFromVaultRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


tagKeys
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
A list of tag keys. Each corresponding tag is removed from the vault.








Class com.amazonaws.services.glacier.model.RequestTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


code
String code








Class com.amazonaws.services.glacier.model.SetDataRetrievalPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


policy
DataRetrievalPolicy policy
The data retrieval policy in JSON format.








Class com.amazonaws.services.glacier.model.SetVaultAccessPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


policy
VaultAccessPolicy policy
The vault access policy as a JSON string.








Class com.amazonaws.services.glacier.model.SetVaultNotificationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


vaultNotificationConfig
VaultNotificationConfig vaultNotificationConfig
Provides options for specifying notification configuration.








Class com.amazonaws.services.glacier.model.UploadArchiveRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


contentLength
Long contentLength


vaultName
String vaultName
The name of the vault.


accountId
String accountId
The 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.


archiveDescription
String archiveDescription
The optional description of the archive you are uploading.


checksum
String checksum
The SHA256 tree hash of the data being uploaded.


body
InputStream body
The data to upload.

 This stream must implement mark/reset in order for signature calculation to be performed
 before this data is read for the request payload.








Class com.amazonaws.services.glacier.model.UploadArchiveResult extends Object implements Serializable




Serialized Fields


location
String location
The relative URI path of the newly added archive resource.


checksum
String checksum
The checksum of the archive computed by Amazon Glacier.


archiveId
String archiveId
The ID of the archive. This value is also included as part of the
 location.








Class com.amazonaws.services.glacier.model.UploadListElement extends Object implements Serializable




Serialized Fields


multipartUploadId
String multipartUploadId
The ID of a multipart upload.


vaultARN
String vaultARN
The Amazon Resource Name (ARN) of the vault that contains the archive.


archiveDescription
String archiveDescription
The description of the archive that was specified in the Initiate
 Multipart Upload request.


partSizeInBytes
Long partSizeInBytes
The part size, in bytes, specified in the Initiate Multipart Upload
 request. This is the size of all the parts in the upload except the
 last part, which may be smaller than this size.


creationDate
String creationDate
The UTC time at which the multipart upload was initiated.








Class com.amazonaws.services.glacier.model.UploadMultipartPartRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountId
String accountId
The 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.


vaultName
String vaultName
The name of the vault.


uploadId
String uploadId
The upload ID of the multipart upload.


checksum
String checksum
The SHA256 tree hash of the data being uploaded.


range
String range
Identifies the range of bytes in the assembled archive that will be
 uploaded in this part. Amazon Glacier uses this information to
 assemble the archive in the proper sequence. The format of this header
 follows RFC 2616. An example header is Content-Range:bytes
 0-4194303/*.


body
InputStream body
The data to upload.

 This stream must implement mark/reset in order for signature calculation to be performed
 before this data is read for the request payload.








Class com.amazonaws.services.glacier.model.UploadMultipartPartResult extends Object implements Serializable




Serialized Fields


checksum
String checksum
The SHA256 tree hash that Amazon Glacier computed for the uploaded
 part.








Class com.amazonaws.services.glacier.model.VaultAccessPolicy extends Object implements Serializable




Serialized Fields


policy
String policy
The vault access policy.








Class com.amazonaws.services.glacier.model.VaultLockPolicy extends Object implements Serializable




Serialized Fields


policy
String policy
The vault lock policy.








Class com.amazonaws.services.glacier.model.VaultNotificationConfig extends Object implements Serializable




Serialized Fields


sNSTopic
String sNSTopic
The Amazon Simple Notification Service (Amazon SNS) topic Amazon
 Resource Name (ARN).


events
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
A list of one or more events for which Amazon Glacier will send a
 notification to the specified Amazon SNS topic.








Package com.amazonaws.services.identitymanagement.model




Class com.amazonaws.services.identitymanagement.model.AccessKey extends Object implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user that the access key is associated with.
 


accessKeyId
String accessKeyId

 The ID for this access key.
 


status
String status

 The status of the access key. Active means the key is valid
 for API calls, while Inactive means it is not.
 


secretAccessKey
String secretAccessKey

 The secret key used to sign requests.
 


createDate
Date createDate

 The date when the access key was created.
 








Class com.amazonaws.services.identitymanagement.model.AccessKeyLastUsed extends Object implements Serializable




Serialized Fields


lastUsedDate
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
 
 
 


serviceName
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
 
 
 


region
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.
 








Class com.amazonaws.services.identitymanagement.model.AccessKeyMetadata extends Object implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user that the key is associated with.
 


accessKeyId
String accessKeyId

 The ID for this access key.
 


status
String status

 The status of the access key. Active means the key is valid
 for API calls; Inactive means it is not.
 


createDate
Date createDate

 The date when the access key was created.
 








Class com.amazonaws.services.identitymanagement.model.AddClientIDToOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


openIDConnectProviderArn
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.
 


clientID
String clientID

 The client ID (also known as audience) to add to the IAM OpenID Connect
 provider.
 








Class com.amazonaws.services.identitymanagement.model.AddRoleToInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to update.
 


roleName
String roleName

 The name of the role to add.
 








Class com.amazonaws.services.identitymanagement.model.AddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name of the group to update.
 


userName
String userName

 The name of the user to add.
 








Class com.amazonaws.services.identitymanagement.model.AttachedPolicy extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The friendly name of the attached policy.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.AttachGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) of the group to attach the policy to.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.AttachRolePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the role to attach the policy to.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.AttachUserPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the user to attach the policy to.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


oldPassword
String oldPassword

 The IAM user's current password.
 


newPassword
String newPassword

 The new password. The new password must conform to the AWS account's
 password policy, if one exists.
 








Class com.amazonaws.services.identitymanagement.model.ContextEntry extends Object implements Serializable




Serialized Fields


contextKeyName
String contextKeyName

 The full name of a condition context key, including the service prefix.
 For example, aws:SourceIp or s3:VersionId.
 


contextKeyValues
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.
 


contextKeyType
String contextKeyType

 The data type of the value (or values) specified in the
 ContextKeyValues parameter.
 








Class com.amazonaws.services.identitymanagement.model.CreateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The user name that the new key will belong to.
 








Class com.amazonaws.services.identitymanagement.model.CreateAccessKeyResult extends Object implements Serializable




Serialized Fields


accessKey
AccessKey accessKey

 Information about the access key.
 








Class com.amazonaws.services.identitymanagement.model.CreateAccountAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountAlias
String accountAlias

 The account alias to create.
 








Class com.amazonaws.services.identitymanagement.model.CreateGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


path
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
 (/).
 


groupName
String groupName

 The name of the group to create. Do not include the path in this value.
 








Class com.amazonaws.services.identitymanagement.model.CreateGroupResult extends Object implements Serializable




Serialized Fields


group
Group group

 Information about the group.
 








Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to create.
 


path
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
 (/).
 








Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileResult extends Object implements Serializable




Serialized Fields


instanceProfile
InstanceProfile instanceProfile

 Information about the instance profile.
 








Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user to create a password for.
 


password
String password

 The new password for the user.
 


passwordResetRequired
Boolean passwordResetRequired

 Specifies whether the user is required to set a new password on next
 sign-in.
 








Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileResult extends Object implements Serializable




Serialized Fields


loginProfile
LoginProfile loginProfile

 The user name and password create date.
 








Class com.amazonaws.services.identitymanagement.model.CreateOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


url
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.
 


clientIDList
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.
 


thumbprintList
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.
 








Class com.amazonaws.services.identitymanagement.model.CreateOpenIDConnectProviderResult extends Object implements Serializable




Serialized Fields


openIDConnectProviderArn
String openIDConnectProviderArn

 The Amazon Resource Name (ARN) of the IAM OpenID Connect provider that
 was created. For more information, see
 OpenIDConnectProviderListEntry.
 








Class com.amazonaws.services.identitymanagement.model.CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy document.
 


path
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
 (/).
 


policyDocument
String policyDocument

 The policy document.
 


description
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.
 








Class com.amazonaws.services.identitymanagement.model.CreatePolicyResult extends Object implements Serializable




Serialized Fields


policy
Policy policy

 Information about the policy.
 








Class com.amazonaws.services.identitymanagement.model.CreatePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn


policyDocument
String policyDocument

 The policy document.
 


setAsDefault
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.
 








Class com.amazonaws.services.identitymanagement.model.CreatePolicyVersionResult extends Object implements Serializable




Serialized Fields


policyVersion
PolicyVersion policyVersion

 Information about the policy version.
 








Class com.amazonaws.services.identitymanagement.model.CreateRoleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


path
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
 (/).
 


roleName
String roleName

 The name of the role to create.
 


assumeRolePolicyDocument
String assumeRolePolicyDocument

 The trust relationship policy document that grants an entity permission
 to assume the role.
 








Class com.amazonaws.services.identitymanagement.model.CreateRoleResult extends Object implements Serializable




Serialized Fields


role
Role role

 Information about the role.
 








Class com.amazonaws.services.identitymanagement.model.CreateSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sAMLMetadataDocument
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
 


name
String name

 The name of the provider to create.
 








Class com.amazonaws.services.identitymanagement.model.CreateSAMLProviderResult extends Object implements Serializable




Serialized Fields


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider.
 








Class com.amazonaws.services.identitymanagement.model.CreateUserRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


path
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
 (/).
 


userName
String userName

 The name of the user to create.
 








Class com.amazonaws.services.identitymanagement.model.CreateUserResult extends Object implements Serializable




Serialized Fields


user
User user

 Information about the user.
 








Class com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


path
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
 (/).
 


virtualMFADeviceName
String virtualMFADeviceName

 The name of the virtual MFA device. Use with path to uniquely identify a
 virtual MFA device.
 








Class com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceResult extends Object implements Serializable




Serialized Fields


virtualMFADevice
VirtualMFADevice virtualMFADevice

 A newly created virtual MFA device.
 








Class com.amazonaws.services.identitymanagement.model.CredentialReportExpiredException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.CredentialReportNotPresentException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.CredentialReportNotReadyException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.DeactivateMFADeviceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose MFA device you want to deactivate.
 


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual
 MFA devices, the serial number is the device ARN.
 








Class com.amazonaws.services.identitymanagement.model.DeleteAccessKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose key you want to delete.
 


accessKeyId
String accessKeyId

 The access key ID for the access key ID and secret access key you want to
 delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteAccountAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accountAlias
String accountAlias

 The name of the account alias to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.DeleteConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.DeleteGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) identifying the group that the policy
 is embedded in.
 


policyName
String policyName

 The name identifying the policy document to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name of the group to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteLoginProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose password you want to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


openIDConnectProviderArn
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.
 








Class com.amazonaws.services.identitymanagement.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.DeletePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn


versionId
String versionId

 The policy version to delete.
 
 
 For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.DeleteRolePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) identifying the role that the policy is
 embedded in.
 


policyName
String policyName

 The name identifying the policy document to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteRoleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name of the role to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteServerCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


serverCertificateName
String serverCertificateName

 The name of the server certificate you want to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user the signing certificate belongs to.
 


certificateId
String certificateId

 The ID of the signing certificate to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 








Class com.amazonaws.services.identitymanagement.model.DeleteUserPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name (friendly name, not ARN) identifying the user that the policy is
 embedded in.
 


policyName
String policyName

 The name identifying the policy document to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteUserRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user to delete.
 








Class com.amazonaws.services.identitymanagement.model.DeleteVirtualMFADeviceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual
 MFA devices, the serial number is the same as the ARN.
 








Class com.amazonaws.services.identitymanagement.model.DetachGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) of the group to detach the policy from.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.DetachRolePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the role to detach the policy from.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.DetachUserPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the user to detach the policy from.
 


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.DuplicateCertificateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.DuplicateSSHPublicKeyException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.EnableMFADeviceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user for whom you want to enable the MFA device.
 


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual
 MFA devices, the serial number is the device ARN.
 


authenticationCode1
String authenticationCode1

 An authentication code emitted by the device.
 


authenticationCode2
String authenticationCode2

 A subsequent authentication code emitted by the device.
 








Class com.amazonaws.services.identitymanagement.model.EntityAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.EntityTemporarilyUnmodifiableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.EvaluationResult extends Object implements Serializable




Serialized Fields


evalActionName
String evalActionName

 The name of the API action tested on the indicated resource.
 


evalResourceName
String evalResourceName

 The ARN of the resource that the indicated API action was tested on.
 


evalDecision
String evalDecision

 The result of the simulation.
 


matchedStatements
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.
 


missingContextValues
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.
 
 


evalDecisionDetails
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
 


resourceSpecificResults
com.amazonaws.internal.SdkInternalList<T> resourceSpecificResults

 The individual results of the simulation of the API action specified in
 EvalActionName on each resource.
 








Class com.amazonaws.services.identitymanagement.model.GenerateCredentialReportRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GenerateCredentialReportResult extends Object implements Serializable




Serialized Fields


state
String state

 Information about the state of the credential report.
 


description
String description

 Information about the credential report.
 








Class com.amazonaws.services.identitymanagement.model.GetAccessKeyLastUsedRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


accessKeyId
String accessKeyId

 The identifier of an access key.
 








Class com.amazonaws.services.identitymanagement.model.GetAccessKeyLastUsedResult extends Object implements Serializable




Serialized Fields


userName
String userName

 The name of the AWS IAM user that owns this access key.
 


accessKeyLastUsed
AccessKeyLastUsed accessKeyLastUsed

 Contains information about the last time the access key was used.
 








Class com.amazonaws.services.identitymanagement.model.GetAccountAuthorizationDetailsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


filter
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.
 


maxItems
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.GetAccountAuthorizationDetailsResult extends Object implements Serializable




Serialized Fields


userDetailList
com.amazonaws.internal.SdkInternalList<T> userDetailList

 A list containing information about IAM users.
 


groupDetailList
com.amazonaws.internal.SdkInternalList<T> groupDetailList

 A list containing information about IAM groups.
 


roleDetailList
com.amazonaws.internal.SdkInternalList<T> roleDetailList

 A list containing information about IAM roles.
 


policies
com.amazonaws.internal.SdkInternalList<T> policies

 A list containing information about managed policies.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyResult extends Object implements Serializable




Serialized Fields


passwordPolicy
PasswordPolicy passwordPolicy








Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryResult extends Object implements Serializable




Serialized Fields


summaryMap
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.
 
 
 
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForCustomPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyInputList
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.
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForCustomPolicyResult extends Object implements Serializable




Serialized Fields


contextKeyNames
com.amazonaws.internal.SdkInternalList<T> contextKeyNames

 The list of context keys that are used in the Condition
 elements of the input policies.
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policySourceArn
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.
 


policyInputList
com.amazonaws.internal.SdkInternalList<T> policyInputList

 A optional list of additional policies for which you want list of context
 keys used in Condition elements.
 








Class com.amazonaws.services.identitymanagement.model.GetContextKeysForPrincipalPolicyResult extends Object implements Serializable




Serialized Fields


contextKeyNames
com.amazonaws.internal.SdkInternalList<T> contextKeyNames

 The list of context keys that are used in the Condition
 elements of the input policies.
 








Class com.amazonaws.services.identitymanagement.model.GetCredentialReportRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.GetCredentialReportResult extends Object implements Serializable




Serialized Fields


content
ByteBuffer content

 Contains the credential report. The report is Base64-encoded.
 


reportFormat
String reportFormat

 The format (MIME type) of the credential report.
 


generatedTime
Date generatedTime

 The date and time when the credential report was created, in ISO 8601 date-time format.
 








Class com.amazonaws.services.identitymanagement.model.GetGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name of the group the policy is associated with.
 


policyName
String policyName

 The name of the policy document to get.
 








Class com.amazonaws.services.identitymanagement.model.GetGroupPolicyResult extends Object implements Serializable




Serialized Fields


groupName
String groupName

 The group the policy is associated with.
 


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.GetGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name of the group.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.GetGroupResult extends Object implements Serializable




Serialized Fields


group
Group group

 Information about the group.
 


users
com.amazonaws.internal.SdkInternalList<T> users

 A list of users in the group.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.GetInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to get information about.
 








Class com.amazonaws.services.identitymanagement.model.GetInstanceProfileResult extends Object implements Serializable




Serialized Fields


instanceProfile
InstanceProfile instanceProfile

 Information about the instance profile.
 








Class com.amazonaws.services.identitymanagement.model.GetLoginProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose login profile you want to retrieve.
 








Class com.amazonaws.services.identitymanagement.model.GetLoginProfileResult extends Object implements Serializable




Serialized Fields


loginProfile
LoginProfile loginProfile

 The user name and password create date for the user.
 








Class com.amazonaws.services.identitymanagement.model.GetOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


openIDConnectProviderArn
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.
 








Class com.amazonaws.services.identitymanagement.model.GetOpenIDConnectProviderResult extends Object implements Serializable




Serialized Fields


url
String url

 The URL that the IAM OpenID Connect provider is associated with. For more
 information, see CreateOpenIDConnectProvider.
 


clientIDList
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.
 


thumbprintList
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.
 


createDate
Date createDate

 The date and time when the IAM OpenID Connect provider entity was created
 in the AWS account.
 








Class com.amazonaws.services.identitymanagement.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn








Class com.amazonaws.services.identitymanagement.model.GetPolicyResult extends Object implements Serializable




Serialized Fields


policy
Policy policy

 Information about the policy.
 








Class com.amazonaws.services.identitymanagement.model.GetPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn


versionId
String versionId

 Identifies the policy version to retrieve.
 








Class com.amazonaws.services.identitymanagement.model.GetPolicyVersionResult extends Object implements Serializable




Serialized Fields


policyVersion
PolicyVersion policyVersion

 Information about the policy version.
 
 
 For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.
 








Class com.amazonaws.services.identitymanagement.model.GetRolePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name of the role associated with the policy.
 


policyName
String policyName

 The name of the policy document to get.
 








Class com.amazonaws.services.identitymanagement.model.GetRolePolicyResult extends Object implements Serializable




Serialized Fields


roleName
String roleName

 The role the policy is associated with.
 


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.GetRoleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name of the role to get information about.
 








Class com.amazonaws.services.identitymanagement.model.GetRoleResult extends Object implements Serializable




Serialized Fields


role
Role role

 Information about the role.
 








Class com.amazonaws.services.identitymanagement.model.GetSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider to get information
 about.
 








Class com.amazonaws.services.identitymanagement.model.GetSAMLProviderResult extends Object implements Serializable




Serialized Fields


sAMLMetadataDocument
String sAMLMetadataDocument

 The XML metadata document that includes information about an identity
 provider.
 


createDate
Date createDate

 The date and time when the SAML provider was created.
 


validUntil
Date validUntil

 The expiration date and time for the SAML provider.
 








Class com.amazonaws.services.identitymanagement.model.GetServerCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


serverCertificateName
String serverCertificateName

 The name of the server certificate you want to retrieve information
 about.
 








Class com.amazonaws.services.identitymanagement.model.GetServerCertificateResult extends Object implements Serializable




Serialized Fields


serverCertificate
ServerCertificate serverCertificate

 Information about the server certificate.
 








Class com.amazonaws.services.identitymanagement.model.GetSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 


encoding
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.
 








Class com.amazonaws.services.identitymanagement.model.GetSSHPublicKeyResult extends Object implements Serializable




Serialized Fields


sSHPublicKey
SSHPublicKey sSHPublicKey

 Information about the SSH public key.
 








Class com.amazonaws.services.identitymanagement.model.GetUserPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user who the policy is associated with.
 


policyName
String policyName

 The name of the policy document to get.
 








Class com.amazonaws.services.identitymanagement.model.GetUserPolicyResult extends Object implements Serializable




Serialized Fields


userName
String userName

 The user the policy is associated with.
 


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.GetUserRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
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.
 








Class com.amazonaws.services.identitymanagement.model.GetUserResult extends Object implements Serializable




Serialized Fields


user
User user

 Information about the user.
 








Class com.amazonaws.services.identitymanagement.model.Group extends Object implements Serializable




Serialized Fields


path
String path

 The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
 


groupName
String groupName

 The friendly name that identifies the group.
 


groupId
String groupId

 The stable and unique string identifying the group. For more information
 about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
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.
 


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the group was created.
 








Class com.amazonaws.services.identitymanagement.model.GroupDetail extends Object implements Serializable




Serialized Fields


path
String path

 The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.
 


groupName
String groupName

 The friendly name that identifies the group.
 


groupId
String groupId

 The stable and unique string identifying the group. For more information
 about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
String arn


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the group was created.
 


groupPolicyList
com.amazonaws.internal.SdkInternalList<T> groupPolicyList

 A list of the inline policies embedded in the group.
 


attachedManagedPolicies
com.amazonaws.internal.SdkInternalList<T> attachedManagedPolicies

 A list of the managed policies attached to the group.
 








Class com.amazonaws.services.identitymanagement.model.InstanceProfile extends Object implements Serializable




Serialized Fields


path
String path

 The path to the instance profile. For more information about paths, see
 IAM Identifiers in the Using IAM guide.
 


instanceProfileName
String instanceProfileName

 The name identifying the instance profile.
 


instanceProfileId
String instanceProfileId

 The stable and unique string identifying the instance profile. For more
 information about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
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.
 


createDate
Date createDate

 The date when the instance profile was created.
 


roles
com.amazonaws.internal.SdkInternalList<T> roles

 The role associated with the instance profile.
 








Class com.amazonaws.services.identitymanagement.model.InvalidAuthenticationCodeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidCertificateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidPublicKeyException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.InvalidUserTypeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.KeyPairMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ListAccessKeysRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAccessKeysResult extends Object implements Serializable




Serialized Fields


accessKeyMetadata
com.amazonaws.internal.SdkInternalList<T> accessKeyMetadata

 A list of access key metadata.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAccountAliasesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAccountAliasesResult extends Object implements Serializable




Serialized Fields


accountAliases
com.amazonaws.internal.SdkInternalList<T> accountAliases

 A list of aliases associated with the account. AWS supports only one
 alias per account.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedGroupPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) of the group to list attached policies
 for.
 


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedGroupPoliciesResult extends Object implements Serializable




Serialized Fields


attachedPolicies
com.amazonaws.internal.SdkInternalList<T> attachedPolicies

 A list of the attached policies.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedRolePoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) of the role to list attached policies
 for.
 


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedRolePoliciesResult extends Object implements Serializable




Serialized Fields


attachedPolicies
com.amazonaws.internal.SdkInternalList<T> attachedPolicies

 A list of the attached policies.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedUserPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name (friendly name, not ARN) of the user to list attached policies
 for.
 


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListAttachedUserPoliciesResult extends Object implements Serializable




Serialized Fields


attachedPolicies
com.amazonaws.internal.SdkInternalList<T> attachedPolicies

 A list of the attached policies.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListEntitiesForPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn


entityFilter
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.
 


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListEntitiesForPolicyResult extends Object implements Serializable




Serialized Fields


policyGroups
com.amazonaws.internal.SdkInternalList<T> policyGroups

 A list of groups that the policy is attached to.
 


policyUsers
com.amazonaws.internal.SdkInternalList<T> policyUsers

 A list of users that the policy is attached to.
 


policyRoles
com.amazonaws.internal.SdkInternalList<T> policyRoles

 A list of roles that the policy is attached to.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name of the group to list policies for.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupPoliciesResult extends Object implements Serializable




Serialized Fields


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 A list of policy names.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user to list groups for.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserResult extends Object implements Serializable




Serialized Fields


groups
com.amazonaws.internal.SdkInternalList<T> groups

 A list of groups.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListGroupsResult extends Object implements Serializable




Serialized Fields


groups
com.amazonaws.internal.SdkInternalList<T> groups

 A list of groups.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesForRoleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name of the role to list instance profiles for.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesForRoleResult extends Object implements Serializable




Serialized Fields


instanceProfiles
com.amazonaws.internal.SdkInternalList<T> instanceProfiles

 A list of instance profiles.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesResult extends Object implements Serializable




Serialized Fields


instanceProfiles
com.amazonaws.internal.SdkInternalList<T> instanceProfiles

 A list of instance profiles.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListMFADevicesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose MFA devices you want to list.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListMFADevicesResult extends Object implements Serializable




Serialized Fields


mFADevices
com.amazonaws.internal.SdkInternalList<T> mFADevices

 A list of MFA devices.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListOpenIDConnectProvidersRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.ListOpenIDConnectProvidersResult extends Object implements Serializable




Serialized Fields


openIDConnectProviderList
com.amazonaws.internal.SdkInternalList<T> openIDConnectProviderList

 The list of IAM OpenID Connect providers in the AWS account.
 








Class com.amazonaws.services.identitymanagement.model.ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


scope
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.
 


onlyAttached
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.
 


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListPoliciesResult extends Object implements Serializable




Serialized Fields


policies
com.amazonaws.internal.SdkInternalList<T> policies

 A list of policies.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListPolicyVersionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListPolicyVersionsResult extends Object implements Serializable




Serialized Fields


versions
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.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name of the role to list policies for.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesResult extends Object implements Serializable




Serialized Fields


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 A list of policy names.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListRolesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListRolesResult extends Object implements Serializable




Serialized Fields


roles
com.amazonaws.internal.SdkInternalList<T> roles

 A list of roles.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListSAMLProvidersRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.identitymanagement.model.ListSAMLProvidersResult extends Object implements Serializable




Serialized Fields


sAMLProviderList
com.amazonaws.internal.SdkInternalList<T> sAMLProviderList

 The list of SAML providers for this account.
 








Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesResult extends Object implements Serializable




Serialized Fields


serverCertificateMetadataList
com.amazonaws.internal.SdkInternalList<T> serverCertificateMetadataList

 A list of server certificates.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesResult extends Object implements Serializable




Serialized Fields


certificates
com.amazonaws.internal.SdkInternalList<T> certificates

 A list of the user's signing certificate information.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListSSHPublicKeysRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListSSHPublicKeysResult extends Object implements Serializable




Serialized Fields


sSHPublicKeys
com.amazonaws.internal.SdkInternalList<T> sSHPublicKeys

 A list of SSH public keys.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user to list policies for.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesResult extends Object implements Serializable




Serialized Fields


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 A list of policy names.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListUsersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pathPrefix
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListUsersResult extends Object implements Serializable




Serialized Fields


users
com.amazonaws.internal.SdkInternalList<T> users

 A list of users.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assignmentStatus
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.
 


marker
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.
 


maxItems
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.
 








Class com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesResult extends Object implements Serializable




Serialized Fields


virtualMFADevices
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.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.LoginProfile extends Object implements Serializable




Serialized Fields


userName
String userName

 The name of the user, which can be used for signing in to the AWS
 Management Console.
 


createDate
Date createDate

 The date when the password for the user was created.
 


passwordResetRequired
Boolean passwordResetRequired

 Specifies whether the user is required to set a new password on next
 sign-in.
 








Class com.amazonaws.services.identitymanagement.model.MalformedCertificateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.ManagedPolicyDetail extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The friendly name (not ARN) identifying the policy.
 


policyId
String policyId

 The stable and unique string identifying the policy.
 
 
 For more information about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
String arn


path
String path

 The path to the policy.
 
 
 For more information about paths, see IAM Identifiers in the Using IAM guide.
 


defaultVersionId
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.
 


attachmentCount
Integer attachmentCount

 The number of principal entities (users, groups, and roles) that the
 policy is attached to.
 


isAttachable
Boolean isAttachable

 Specifies whether the policy can be attached to an IAM user, group, or
 role.
 


description
String description

 A friendly description of the policy.
 


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the policy was created.
 


updateDate
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.
 


policyVersionList
com.amazonaws.internal.SdkInternalList<T> policyVersionList

 A list containing information about the versions of the policy.
 








Class com.amazonaws.services.identitymanagement.model.MFADevice extends Object implements Serializable




Serialized Fields


userName
String userName

 The user with whom the MFA device is associated.
 


serialNumber
String serialNumber

 The serial number that uniquely identifies the MFA device. For virtual
 MFA devices, the serial number is the device ARN.
 


enableDate
Date enableDate

 The date when the MFA device was enabled for the user.
 








Class com.amazonaws.services.identitymanagement.model.NoSuchEntityException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.OpenIDConnectProviderListEntry extends Object implements Serializable




Serialized Fields


arn
String arn








Class com.amazonaws.services.identitymanagement.model.PasswordPolicy extends Object implements Serializable




Serialized Fields


minimumPasswordLength
Integer minimumPasswordLength

 Minimum length to require for IAM user passwords.
 


requireSymbols
Boolean requireSymbols

 Specifies whether to require symbols for IAM user passwords.
 


requireNumbers
Boolean requireNumbers

 Specifies whether to require numbers for IAM user passwords.
 


requireUppercaseCharacters
Boolean requireUppercaseCharacters

 Specifies whether to require uppercase characters for IAM user passwords.
 


requireLowercaseCharacters
Boolean requireLowercaseCharacters

 Specifies whether to require lowercase characters for IAM user passwords.
 


allowUsersToChangePassword
Boolean allowUsersToChangePassword

 Specifies whether IAM users are allowed to change their own password.
 


expirePasswords
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.
 


maxPasswordAge
Integer maxPasswordAge

 The number of days that an IAM user password is valid.
 


passwordReusePrevention
Integer passwordReusePrevention

 Specifies the number of previous passwords that IAM users are prevented
 from reusing.
 


hardExpiry
Boolean hardExpiry

 Specifies whether IAM users are prevented from setting a new password
 after their password has expired.
 








Class com.amazonaws.services.identitymanagement.model.PasswordPolicyViolationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.Policy extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The friendly name (not ARN) identifying the policy.
 


policyId
String policyId

 The stable and unique string identifying the policy.
 
 
 For more information about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
String arn


path
String path

 The path to the policy.
 
 
 For more information about paths, see IAM Identifiers in the Using IAM guide.
 


defaultVersionId
String defaultVersionId

 The identifier for the version of the policy that is set as the default
 version.
 


attachmentCount
Integer attachmentCount

 The number of entities (users, groups, and roles) that the policy is
 attached to.
 


isAttachable
Boolean isAttachable

 Specifies whether the policy can be attached to an IAM user, group, or
 role.
 


description
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.
 


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the policy was created.
 


updateDate
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.
 








Class com.amazonaws.services.identitymanagement.model.PolicyDetail extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.PolicyEvaluationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.PolicyGroup extends Object implements Serializable




Serialized Fields


groupName
String groupName

 The name (friendly name, not ARN) identifying the group.
 


groupId
String groupId








Class com.amazonaws.services.identitymanagement.model.PolicyRole extends Object implements Serializable




Serialized Fields


roleName
String roleName

 The name (friendly name, not ARN) identifying the role.
 


roleId
String roleId








Class com.amazonaws.services.identitymanagement.model.PolicyUser extends Object implements Serializable




Serialized Fields


userName
String userName

 The name (friendly name, not ARN) identifying the user.
 


userId
String userId








Class com.amazonaws.services.identitymanagement.model.PolicyVersion extends Object implements Serializable




Serialized Fields


document
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.
 


versionId
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.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is set as the policy's default
 version.
 


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the policy version was created.
 








Class com.amazonaws.services.identitymanagement.model.Position extends Object implements Serializable




Serialized Fields


line
Integer line

 The line containing the specified position in the document.
 


column
Integer column

 The column in the line containing the specified position in the document.
 








Class com.amazonaws.services.identitymanagement.model.PutGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name of the group to associate the policy with.
 


policyName
String policyName

 The name of the policy document.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.PutRolePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name of the role to associate the policy with.
 


policyName
String policyName

 The name of the policy document.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.PutUserPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user to associate the policy with.
 


policyName
String policyName

 The name of the policy document.
 


policyDocument
String policyDocument

 The policy document.
 








Class com.amazonaws.services.identitymanagement.model.RemoveClientIDFromOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


openIDConnectProviderArn
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.
 


clientID
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.
 








Class com.amazonaws.services.identitymanagement.model.RemoveRoleFromInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceProfileName
String instanceProfileName

 The name of the instance profile to update.
 


roleName
String roleName

 The name of the role to remove.
 








Class com.amazonaws.services.identitymanagement.model.RemoveUserFromGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 The name of the group to update.
 


userName
String userName

 The name of the user to remove.
 








Class com.amazonaws.services.identitymanagement.model.ResourceSpecificResult extends Object implements Serializable




Serialized Fields


evalResourceName
String evalResourceName

 The name of the simulated resource, in Amazon Resource Name (ARN) format.
 


evalResourceDecision
String evalResourceDecision

 The result of the simulation of the simulated API action on the resource
 specified in EvalResourceName.
 


matchedStatements
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.
 


missingContextValues
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.
 


evalDecisionDetails
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.
 








Class com.amazonaws.services.identitymanagement.model.ResyncMFADeviceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose MFA device you want to resynchronize.
 


serialNumber
String serialNumber

 Serial number that uniquely identifies the MFA device.
 


authenticationCode1
String authenticationCode1

 An authentication code emitted by the device.
 


authenticationCode2
String authenticationCode2

 A subsequent authentication code emitted by the device.
 








Class com.amazonaws.services.identitymanagement.model.Role extends Object implements Serializable




Serialized Fields


path
String path

 The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
 


roleName
String roleName

 The friendly name that identifies the role.
 


roleId
String roleId

 The stable and unique string identifying the role. For more information
 about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
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.
 


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the role was created.
 


assumeRolePolicyDocument
String assumeRolePolicyDocument

 The policy that grants an entity permission to assume the role.
 








Class com.amazonaws.services.identitymanagement.model.RoleDetail extends Object implements Serializable




Serialized Fields


path
String path

 The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.
 


roleName
String roleName

 The friendly name that identifies the role.
 


roleId
String roleId

 The stable and unique string identifying the role. For more information
 about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
String arn


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the role was created.
 


assumeRolePolicyDocument
String assumeRolePolicyDocument

 The trust policy that grants permission to assume the role.
 


instanceProfileList
com.amazonaws.internal.SdkInternalList<T> instanceProfileList


rolePolicyList
com.amazonaws.internal.SdkInternalList<T> rolePolicyList

 A list of inline policies embedded in the role. These policies are the
 role's access (permissions) policies.
 


attachedManagedPolicies
com.amazonaws.internal.SdkInternalList<T> attachedManagedPolicies

 A list of managed policies attached to the role. These policies are the
 role's access (permissions) policies.
 








Class com.amazonaws.services.identitymanagement.model.SAMLProviderListEntry extends Object implements Serializable




Serialized Fields


arn
String arn

 The Amazon Resource Name (ARN) of the SAML provider.
 


validUntil
Date validUntil

 The expiration date and time for the SAML provider.
 


createDate
Date createDate

 The date and time when the SAML provider was created.
 








Class com.amazonaws.services.identitymanagement.model.ServerCertificate extends Object implements Serializable




Serialized Fields


serverCertificateMetadata
ServerCertificateMetadata serverCertificateMetadata

 The meta information of the server certificate, such as its name, path,
 ID, and ARN.
 


certificateBody
String certificateBody

 The contents of the public key certificate.
 


certificateChain
String certificateChain

 The contents of the public key certificate chain.
 








Class com.amazonaws.services.identitymanagement.model.ServerCertificateMetadata extends Object implements Serializable




Serialized Fields


path
String path

 The path to the server certificate. For more information about paths, see
 IAM Identifiers in the Using IAM guide.
 


serverCertificateName
String serverCertificateName

 The name that identifies the server certificate.
 


serverCertificateId
String serverCertificateId

 The stable and unique string identifying the server certificate. For more
 information about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
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.
 


uploadDate
Date uploadDate

 The date when the server certificate was uploaded.
 


expiration
Date expiration

 The date on which the certificate is set to expire.
 








Class com.amazonaws.services.identitymanagement.model.ServiceFailureException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.SetDefaultPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyArn
String policyArn


versionId
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.
 








Class com.amazonaws.services.identitymanagement.model.SigningCertificate extends Object implements Serializable




Serialized Fields


userName
String userName

 The name of the user the signing certificate is associated with.
 


certificateId
String certificateId

 The ID for the signing certificate.
 


certificateBody
String certificateBody

 The contents of the signing certificate.
 


status
String status

 The status of the signing certificate. Active means the key
 is valid for API calls, while Inactive means it is not.
 


uploadDate
Date uploadDate

 The date when the signing certificate was uploaded.
 








Class com.amazonaws.services.identitymanagement.model.SimulateCustomPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyInputList
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.
 


actionNames
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.
 


resourceArns
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.
 


resourcePolicy
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.
 


resourceOwner
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.
 


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.
 


contextEntries
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.
 


resourceHandlingOption
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
 
 
 


maxItems
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.SimulateCustomPolicyResult extends Object implements Serializable




Serialized Fields


evaluationResults
com.amazonaws.internal.SdkInternalList<T> evaluationResults

 The results of the simulation.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.SimulatePrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policySourceArn
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.
 


policyInputList
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.
 


actionNames
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.
 


resourceArns
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.
 


resourcePolicy
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.
 


resourceOwner
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.
 


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.
 


contextEntries
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.
 


resourceHandlingOption
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
 
 
 


maxItems
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.SimulatePrincipalPolicyResult extends Object implements Serializable




Serialized Fields


evaluationResults
com.amazonaws.internal.SdkInternalList<T> evaluationResults

 The results of the simulation.
 


isTruncated
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.
 


marker
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.
 








Class com.amazonaws.services.identitymanagement.model.SSHPublicKey extends Object implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 


fingerprint
String fingerprint

 The MD5 message digest of the SSH public key.
 


sSHPublicKeyBody
String sSHPublicKeyBody

 The SSH public key.
 


status
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.
 


uploadDate
Date uploadDate

 The date and time, in ISO 8601
 date-time format, when the SSH public key was uploaded.
 








Class com.amazonaws.services.identitymanagement.model.SSHPublicKeyMetadata extends Object implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 


status
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.
 


uploadDate
Date uploadDate

 The date and time, in ISO 8601
 date-time format, when the SSH public key was uploaded.
 








Class com.amazonaws.services.identitymanagement.model.Statement extends Object implements Serializable




Serialized Fields


sourcePolicyId
String sourcePolicyId

 The identifier of the policy that was provided as an input.
 


sourcePolicyType
String sourcePolicyType

 The type of the policy.
 


startPosition
Position startPosition

 The row and column of the beginning of the Statement in an
 IAM policy.
 


endPosition
Position endPosition

 The row and column of the end of a Statement in an IAM
 policy.
 








Class com.amazonaws.services.identitymanagement.model.UnrecognizedPublicKeyEncodingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.identitymanagement.model.UpdateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose key you want to update.
 


accessKeyId
String accessKeyId

 The access key ID of the secret access key you want to update.
 


status
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.
 








Class com.amazonaws.services.identitymanagement.model.UpdateAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


minimumPasswordLength
Integer minimumPasswordLength

 The minimum number of characters allowed in an IAM user password.
 
 
 Default value: 6
 


requireSymbols
Boolean requireSymbols

 Specifies whether IAM user passwords must contain at least one of the
 following non-alphanumeric characters:
 
 
 ! @ # $ % ^ &amp; * ( ) _ + - = [ ] { } | '
 
 
 Default value: false
 


requireNumbers
Boolean requireNumbers

 Specifies whether IAM user passwords must contain at least one numeric
 character (0 to 9).
 
 
 Default value: false
 


requireUppercaseCharacters
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
 


requireLowercaseCharacters
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
 


allowUsersToChangePassword
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
 


maxPasswordAge
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
 


passwordReusePrevention
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
 


hardExpiry
Boolean hardExpiry

 Prevents IAM users from setting a new password after their password has
 expired.
 
 
 Default value: false
 








Class com.amazonaws.services.identitymanagement.model.UpdateAssumeRolePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleName
String roleName

 The name of the role to update.
 


policyDocument
String policyDocument

 The policy that grants an entity permission to assume the role.
 








Class com.amazonaws.services.identitymanagement.model.UpdateGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


groupName
String groupName

 Name of the group to update. If you're changing the name of the group,
 this is the original name.
 


newPath
String newPath

 New path for the group. Only include this if changing the group's path.
 


newGroupName
String newGroupName

 New name for the group. Only include this if changing the group's name.
 








Class com.amazonaws.services.identitymanagement.model.UpdateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user whose password you want to update.
 


password
String password

 The new password for the specified user.
 


passwordResetRequired
Boolean passwordResetRequired

 Require the specified user to set a new password on next sign-in.
 








Class com.amazonaws.services.identitymanagement.model.UpdateOpenIDConnectProviderThumbprintRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


openIDConnectProviderArn
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.
 


thumbprintList
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.
 








Class com.amazonaws.services.identitymanagement.model.UpdateSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sAMLMetadataDocument
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.
 


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider to update.
 








Class com.amazonaws.services.identitymanagement.model.UpdateSAMLProviderResult extends Object implements Serializable




Serialized Fields


sAMLProviderArn
String sAMLProviderArn

 The Amazon Resource Name (ARN) of the SAML provider that was updated.
 








Class com.amazonaws.services.identitymanagement.model.UpdateServerCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


serverCertificateName
String serverCertificateName

 The name of the server certificate that you want to update.
 


newPath
String newPath

 The new path for the server certificate. Include this only if you are
 updating the server certificate's path.
 


newServerCertificateName
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.
 








Class com.amazonaws.services.identitymanagement.model.UpdateSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user the signing certificate belongs to.
 


certificateId
String certificateId

 The ID of the signing certificate you want to update.
 


status
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.
 








Class com.amazonaws.services.identitymanagement.model.UpdateSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user associated with the SSH public key.
 


sSHPublicKeyId
String sSHPublicKeyId

 The unique identifier for the SSH public key.
 


status
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.
 








Class com.amazonaws.services.identitymanagement.model.UpdateUserRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 Name of the user to update. If you're changing the name of the user, this
 is the original user name.
 


newPath
String newPath

 New path for the user. Include this parameter only if you're changing the
 user's path.
 


newUserName
String newUserName

 New name for the user. Include this parameter only if you're changing the
 user's name.
 








Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


path
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
 (/).
 
  If you are uploading a server certificate specifically for use
 with Amazon CloudFront distributions, you must specify a path using the
 --path option. The path must begin with
 /cloudfront and must include a trailing slash (for example,
 /cloudfront/test/). 


serverCertificateName
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.
 


certificateBody
String certificateBody

 The contents of the public key certificate in PEM-encoded format.
 


privateKey
String privateKey

 The contents of the private key in PEM-encoded format.
 


certificateChain
String certificateChain

 The contents of the certificate chain. This is typically a concatenation
 of the PEM-encoded public key certificates of the chain.
 








Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateResult extends Object implements Serializable




Serialized Fields


serverCertificateMetadata
ServerCertificateMetadata serverCertificateMetadata

 The meta information of the uploaded server certificate without its
 certificate body, certificate chain, and private key.
 








Class com.amazonaws.services.identitymanagement.model.UploadSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the user the signing certificate is for.
 


certificateBody
String certificateBody

 The contents of the signing certificate.
 








Class com.amazonaws.services.identitymanagement.model.UploadSigningCertificateResult extends Object implements Serializable




Serialized Fields


certificate
SigningCertificate certificate

 Information about the certificate.
 








Class com.amazonaws.services.identitymanagement.model.UploadSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


userName
String userName

 The name of the IAM user to associate the SSH public key with.
 


sSHPublicKeyBody
String sSHPublicKeyBody

 The SSH public key. The public key must be encoded in ssh-rsa format or
 PEM format.
 








Class com.amazonaws.services.identitymanagement.model.UploadSSHPublicKeyResult extends Object implements Serializable




Serialized Fields


sSHPublicKey
SSHPublicKey sSHPublicKey

 Contains information about the SSH public key.
 








Class com.amazonaws.services.identitymanagement.model.User extends Object implements Serializable




Serialized Fields


path
String path

 The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
 


userName
String userName

 The friendly name identifying the user.
 


userId
String userId

 The stable and unique string identifying the user. For more information
 about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
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.
 


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the user was created.
 


passwordLastUsed
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.
 








Class com.amazonaws.services.identitymanagement.model.UserDetail extends Object implements Serializable




Serialized Fields


path
String path

 The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.
 


userName
String userName

 The friendly name identifying the user.
 


userId
String userId

 The stable and unique string identifying the user. For more information
 about IDs, see IAM Identifiers in the Using IAM guide.
 


arn
String arn


createDate
Date createDate

 The date and time, in ISO 8601
 date-time format, when the user was created.
 


userPolicyList
com.amazonaws.internal.SdkInternalList<T> userPolicyList

 A list of the inline policies embedded in the user.
 


groupList
com.amazonaws.internal.SdkInternalList<T> groupList

 A list of IAM groups that the user is in.
 


attachedManagedPolicies
com.amazonaws.internal.SdkInternalList<T> attachedManagedPolicies

 A list of the managed policies attached to the user.
 








Class com.amazonaws.services.identitymanagement.model.VirtualMFADevice extends Object implements Serializable




Serialized Fields


serialNumber
String serialNumber

 The serial number associated with VirtualMFADevice.
 


base32StringSeed
ByteBuffer base32StringSeed

 The Base32 seed defined as specified in RFC3548. The
 Base32StringSeed is Base64-encoded.
 


qRCodePNG
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 user


enableDate
Date enableDate

 The date and time on which the virtual MFA device was enabled.
 








Package com.amazonaws.services.importexport.model




Class com.amazonaws.services.importexport.model.Artifact extends Object implements Serializable




Serialized Fields


description
String description


uRL
String uRL








Class com.amazonaws.services.importexport.model.BucketPermissionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.CanceledJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.CancelJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobId
String jobId


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.CancelJobResult extends Object implements Serializable




Serialized Fields


success
Boolean success








Class com.amazonaws.services.importexport.model.CreateJobQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.CreateJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobType
String jobType


manifest
String manifest


manifestAddendum
String manifestAddendum


validateOnly
Boolean validateOnly


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.CreateJobResult extends Object implements Serializable




Serialized Fields


jobId
String jobId


jobType
String jobType


signature
String signature


signatureFileContents
String signatureFileContents


warningMessage
String warningMessage


artifactList
com.amazonaws.internal.SdkInternalList<T> artifactList








Class com.amazonaws.services.importexport.model.ExpiredJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.GetShippingLabelRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobIds
com.amazonaws.internal.SdkInternalList<T> jobIds


name
String name


company
String company


phoneNumber
String phoneNumber


country
String country


stateOrProvince
String stateOrProvince


city
String city


postalCode
String postalCode


street1
String street1


street2
String street2


street3
String street3


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.GetShippingLabelResult extends Object implements Serializable




Serialized Fields


shippingLabelURL
String shippingLabelURL


warning
String warning








Class com.amazonaws.services.importexport.model.GetStatusRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobId
String jobId


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.GetStatusResult extends Object implements Serializable




Serialized Fields


jobId
String jobId


jobType
String jobType


locationCode
String locationCode


locationMessage
String locationMessage


progressCode
String progressCode


progressMessage
String progressMessage


carrier
String carrier


trackingNumber
String trackingNumber


logBucket
String logBucket


logKey
String logKey


errorCount
Integer errorCount


signature
String signature


signatureFileContents
String signatureFileContents


currentManifest
String currentManifest


creationDate
Date creationDate


artifactList
com.amazonaws.internal.SdkInternalList<T> artifactList








Class com.amazonaws.services.importexport.model.InvalidAccessKeyIdException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidAddressException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidCustomsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidFileSystemException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidManifestFieldException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.InvalidVersionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.Job extends Object implements Serializable




Serialized Fields


jobId
String jobId


creationDate
Date creationDate


isCanceled
Boolean isCanceled


jobType
String jobType








Class com.amazonaws.services.importexport.model.ListJobsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


maxJobs
Integer maxJobs


marker
String marker


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.ListJobsResult extends Object implements Serializable




Serialized Fields


jobs
com.amazonaws.internal.SdkInternalList<T> jobs


isTruncated
Boolean isTruncated








Class com.amazonaws.services.importexport.model.MalformedManifestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MissingCustomsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MissingManifestFieldException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MissingParameterException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.MultipleRegionsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.NoSuchBucketException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.UnableToCancelJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.UnableToUpdateJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.importexport.model.UpdateJobRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


jobId
String jobId


manifest
String manifest


jobType
String jobType


validateOnly
Boolean validateOnly


aPIVersion
String aPIVersion








Class com.amazonaws.services.importexport.model.UpdateJobResult extends Object implements Serializable




Serialized Fields


success
Boolean success


warningMessage
String warningMessage


artifactList
com.amazonaws.internal.SdkInternalList<T> artifactList








Package com.amazonaws.services.inspector.model




Class com.amazonaws.services.inspector.model.AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode

 Code that indicates the type of error that is generated.
 


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.AddAttributesToFindingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


findingArns
List<E> findingArns

 The ARNs specifying the findings that you want to assign attributes to.
 


attributes
List<E> attributes

 The array of attributes that you want to assign to specified findings.
 








Class com.amazonaws.services.inspector.model.AddAttributesToFindingsResult extends Object implements Serializable




Serialized Fields


failedItems
Map<K,V> failedItems

 Attributes details that cannot be described. An error code is provided
 for each failed item.
 








Class com.amazonaws.services.inspector.model.AgentAlreadyRunningAssessment extends Object implements Serializable




Serialized Fields


agentId
String agentId

 ID of the agent that is running on an EC2 isntance that is already
 particiapting in another started assessment run.
 


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment that has already been started.
 








Class com.amazonaws.services.inspector.model.AgentFilter extends Object implements Serializable




Serialized Fields


agentHealths
List<E> agentHealths

 The current health state of the agent. Values can be set to
 HEALTHY or UNHEALTHY.
 


agentHealthCodes
List<E> agentHealthCodes

 The detailed health state of the agent. Values can be set to IDLE,
 RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and
 UNKNOWN.
 








Class com.amazonaws.services.inspector.model.AgentPreview extends Object implements Serializable




Serialized Fields


agentId
String agentId

 The id of the EC2 instance where the agent is intalled.
 


autoScalingGroup
String autoScalingGroup

 The autoscaling group for the EC2 instance where the agent is installed.
 








Class com.amazonaws.services.inspector.model.AgentsAlreadyRunningAssessmentException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


agents
List<E> agents



agentsTruncated
Boolean agentsTruncated



canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.AssessmentRun extends Object implements Serializable




Serialized Fields


arn
String arn

 The ARN of the assessment run.
 


name
String name

 The auto-generated name for the assessment run.
 


assessmentTemplateArn
String assessmentTemplateArn

 The ARN of the assessment template that is associated with the assessment
 run.
 


state
String state

 The state of the assessment run.
 


durationInSeconds
Integer durationInSeconds

 The duration of the assessment run.
 


rulesPackageArns
List<E> rulesPackageArns

 Rules packages selected for the assessment run.
 


userAttributesForFindings
List<E> userAttributesForFindings

 The user-defined attributes that are assigned to every generated finding.
 


createdAt
Date createdAt

 The time when StartAssessmentRun API was called.
 


startedAt
Date startedAt

 The time when StartAssessmentRun API was called.
 


completedAt
Date completedAt

 Assessment run completion time that corresponds to the rules packages
 evaluation completion time or failure.
 


stateChangedAt
Date stateChangedAt

 The last time when the assessment run's state changed.
 


dataCollected
Boolean dataCollected

 Boolean value (true or false) specifying whether the process of
 collecting data from the agents is completed.
 


stateChanges
List<E> stateChanges

 A list of the assessment run state changes.
 


notifications
List<E> notifications

 A list of notifications for the event subscriptions. A notification about
 a particular generated finding is only added to this list once.
 








Class com.amazonaws.services.inspector.model.AssessmentRunAgent extends Object implements Serializable




Serialized Fields


agentId
String agentId

 AWS account of the EC2 instance where the agent is installed.
 


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run that is associated with the agent.
 


agentHealth
String agentHealth

 The current health state of the agent.
 


agentHealthCode
String agentHealthCode

 The detailed health state of the agent.
 


agentHealthDetails
String agentHealthDetails

 The description for the agent health code.
 


autoScalingGroup
String autoScalingGroup

 The auto-scaling group of the EC2 instance specified by the agent ID.
 


telemetryMetadata
List<E> telemetryMetadata

 The Inspector application data metrics collected by the agent.
 








Class com.amazonaws.services.inspector.model.AssessmentRunFilter extends Object implements Serializable




Serialized Fields


namePattern
String namePattern

 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 assessmentRunName property of the AssessmentRun data
 type.
 


states
List<E> states

 For a record to match a filter, one of the values specified for this data
 type property must be the exact match of the value of the
 assessmentRunState property of the AssessmentRun data type.
 


durationRange
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
 AssessmentRun data type.
 


rulesPackageArns
List<E> rulesPackageArns

 For a record to match a filter, the value specified for this data type
 property must be contained in the list of values of the
 rulesPackages property of the AssessmentRun data type.
 


startTimeRange
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
 AssessmentRun data type.
 


completionTimeRange
TimestampRange completionTimeRange

 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 completedAt property of the
 AssessmentRun data type.
 


stateChangeTimeRange
TimestampRange stateChangeTimeRange

 For a record to match a filter, the value specified for this data type
 property must match the stateChangedAt property of the
 AssessmentRun data type.
 








Class com.amazonaws.services.inspector.model.AssessmentRunInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


assessmentRunArns
List<E> assessmentRunArns

 The ARN(s) of the assessment run(s) that are currently in progress.
 


assessmentRunArnsTruncated
Boolean assessmentRunArnsTruncated

 Boolean value indicating whether the assessment runs ARN list is
 truncated.
 


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.AssessmentRunNotification extends Object implements Serializable




Serialized Fields


dateValue
Date dateValue

 The date of the notification.
 


event
String event

 The event for which a notification is sent.
 


message
String message


error
Boolean error

 The Boolean value that specifies whether the notification represents an
 error.
 


snsTopicArn
String snsTopicArn

 The SNS topic to which the SNS notification is sent.
 


snsPublishStatusCode
String snsPublishStatusCode

 The status code of the SNS notification.
 








Class com.amazonaws.services.inspector.model.AssessmentRunStateChange extends Object implements Serializable




Serialized Fields


stateChangedAt
Date stateChangedAt

 The last time the assessment run state changed.
 


state
String state

 The assessment run state.
 








Class com.amazonaws.services.inspector.model.AssessmentTarget extends Object implements Serializable




Serialized Fields


arn
String arn

 The ARN specifying the Inspector assessment target.
 


name
String name

 The name of the Inspector assessment target.
 


resourceGroupArn
String resourceGroupArn

 The ARN specifying the resource group that is associated with the
 assessment target.
 


createdAt
Date createdAt

 The time at which the assessment target is created.
 


updatedAt
Date updatedAt

 The time at which UpdateAssessmentTarget API is called.
 








Class com.amazonaws.services.inspector.model.AssessmentTargetFilter extends Object implements Serializable




Serialized Fields


assessmentTargetNamePattern
String assessmentTargetNamePattern

 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 assessmentTargetName property of the AssessmentTarget
 data type.
 








Class com.amazonaws.services.inspector.model.AssessmentTemplate extends Object implements Serializable




Serialized Fields


arn
String arn

 The ARN of the assessment template.
 


name
String name

 The name of the assessment template.
 


assessmentTargetArn
String assessmentTargetArn

 The ARN of the assessment target that corresponds to this assessment
 template.
 


durationInSeconds
Integer durationInSeconds

 The duration in seconds specified for this assessment tempate. The
 default value is 3600 seconds (one hour). The maximum value is 86400
 seconds (one day).
 


rulesPackageArns
List<E> rulesPackageArns

 Rules packages specified for this assessment template.
 


userAttributesForFindings
List<E> userAttributesForFindings

 The user-defined attributes that are assigned to every generated finding
 from the assessment run that uses this assessment template.
 


createdAt
Date createdAt

 The time at which the assessment template is created.
 








Class com.amazonaws.services.inspector.model.AssessmentTemplateFilter extends Object implements Serializable




Serialized Fields


namePattern
String namePattern

 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 assessmentTemplateName property of the
 AssessmentTemplate data type.
 


durationRange
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
 AssessmentTemplate data type.
 


rulesPackageArns
List<E> rulesPackageArns

 For a record to match a filter, the value(s) specified for this data type
 property must be contained in the list of values of the
 rulesPackageArns property of the AssessmentTemplate data
 type.
 








Class com.amazonaws.services.inspector.model.AssetAttributes extends Object implements Serializable




Serialized Fields


schemaVersion
Integer schemaVersion

 The schema version of this data type.
 


agentId
String agentId

 The id of the agent that is installed on the EC2 instance where the
 finding is generated.
 


autoScalingGroup
String autoScalingGroup

 The auto-scaling group of the EC2 instance where the finding is
 generated.
 


amiId
String amiId

 Amazon Machine Image(AMI) ID installed on the EC2 instance where the
 finding is generated.
 


hostname
String hostname

 The hostname of the EC2 instance where the finding is generated.
 


ipv4Addresses
List<E> ipv4Addresses

 The list of IP v4 addresses of the EC2 instance where the finding is
 generated.
 








Class com.amazonaws.services.inspector.model.Attribute extends Object implements Serializable




Serialized Fields


key
String key

 The attribute key.
 


value
String value

 The value assigned to the attribute key.
 








Class com.amazonaws.services.inspector.model.CreateAssessmentTargetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTargetName
String assessmentTargetName

 The user-defined name identifying the assessment target that you want to
 create. The name must be unique within the AWS account.
 


resourceGroupArn
String resourceGroupArn

 The ARN specifying the resource group that is used to create the
 assessment target.
 








Class com.amazonaws.services.inspector.model.CreateAssessmentTargetResult extends Object implements Serializable




Serialized Fields


assessmentTargetArn
String assessmentTargetArn

 The ARN specifying the assessment target that is created.
 








Class com.amazonaws.services.inspector.model.CreateAssessmentTemplateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTargetArn
String assessmentTargetArn

 The ARN specifying the assessment target for which you want to create the
 assessment template.
 


assessmentTemplateName
String assessmentTemplateName

 The user-defined name identifying the assessment template that you want
 to create. You can create several assessment templates for an assessment
 target. The names of the assessment templates corresponding to a
 particular assessment target must be unique.
 


durationInSeconds
Integer durationInSeconds

 The duration of the assessment run in seconds. The default value is 3600
 seconds (one hour).
 


rulesPackageArns
List<E> rulesPackageArns

 The ARNs specifying the rules packages that you want to attach to the
 assessment template.
 


userAttributesForFindings
List<E> userAttributesForFindings

 The user-defined attributes that are assigned to every finding generated
 by the assessment run that uses this assessment template.
 








Class com.amazonaws.services.inspector.model.CreateAssessmentTemplateResult extends Object implements Serializable




Serialized Fields


assessmentTemplateArn
String assessmentTemplateArn

 The ARN specifying the assessment template that is created.
 








Class com.amazonaws.services.inspector.model.CreateResourceGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceGroupTags
List<E> resourceGroupTags

 A collection of keys and an array of possible values,
 '[{"key":"key1","values":["Value1","Value2"]},{"key":"Key2","values":["Value3"]}]'
 .
 
 
 For example,'[{"key":"Name","values":["TestEC2Instance"]}]'.
 








Class com.amazonaws.services.inspector.model.CreateResourceGroupResult extends Object implements Serializable




Serialized Fields


resourceGroupArn
String resourceGroupArn

 The ARN specifying the resource group that is created.
 








Class com.amazonaws.services.inspector.model.DeleteAssessmentRunRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN specifying the assessment run that you want to delete.
 








Class com.amazonaws.services.inspector.model.DeleteAssessmentTargetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTargetArn
String assessmentTargetArn

 The ARN specifying the assessment target that you want to delete.
 








Class com.amazonaws.services.inspector.model.DeleteAssessmentTemplateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTemplateArn
String assessmentTemplateArn

 The ARN specifying the assessment template that you want to delete.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentRunsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentRunArns
List<E> assessmentRunArns

 The ARN(s) specifying the assessment run(s) that you want to describe.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentRunsResult extends Object implements Serializable




Serialized Fields


assessmentRuns
List<E> assessmentRuns

 Information about the assessment run(s).
 


failedItems
Map<K,V> failedItems

 Assessment run details that cannot be described. An error code is
 provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentTargetsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTargetArns
List<E> assessmentTargetArns

 The ARN(s) specifying the assessment target(s) that you want to describe.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentTargetsResult extends Object implements Serializable




Serialized Fields


assessmentTargets
List<E> assessmentTargets

 Information about the assessment target(s).
 


failedItems
Map<K,V> failedItems

 Assessment target details that cannot be described. An error code is
 provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentTemplatesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTemplateArns
List<E> assessmentTemplateArns

 The ARN(s) specifying the assessment template(s) that you want to
 describe.
 








Class com.amazonaws.services.inspector.model.DescribeAssessmentTemplatesResult extends Object implements Serializable




Serialized Fields


assessmentTemplates
List<E> assessmentTemplates

 Information about the assessment template(s).
 


failedItems
Map<K,V> failedItems

 Assessment template details that cannot be described. An error code is
 provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeCrossAccountAccessRoleRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.inspector.model.DescribeCrossAccountAccessRoleResult extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN specifying the IAM role that Inspector uses to access your AWS
 account.
 


valid
Boolean valid

 A Boolean value that specifies whether the IAM role has the necessary
 policies attached to enable Inspector to access your AWS account.
 


registeredAt
Date registeredAt

 The date when the cross account access role was registered.
 








Class com.amazonaws.services.inspector.model.DescribeFindingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


findingArns
List<E> findingArns

 The ARN(s) specifying the finding(s) that you want to describe.
 


locale
String locale

 The locale that you want to translate a finding description(s),
 recommendation(s), and the short description(s) that identify the
 finding(s) into.
 








Class com.amazonaws.services.inspector.model.DescribeFindingsResult extends Object implements Serializable




Serialized Fields


findings
List<E> findings

 Information about the finding(s).
 


failedItems
Map<K,V> failedItems

 Finding details that cannot be described. An error code is provided for
 each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeResourceGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceGroupArns
List<E> resourceGroupArns

 The ARN(s) specifying the resource group(s) that you want to describe.
 








Class com.amazonaws.services.inspector.model.DescribeResourceGroupsResult extends Object implements Serializable




Serialized Fields


resourceGroups
List<E> resourceGroups

 Information about the resource group(s).
 


failedItems
Map<K,V> failedItems

 Resource group details that cannot be described. An error code is
 provided for each failed item.
 








Class com.amazonaws.services.inspector.model.DescribeRulesPackagesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


rulesPackageArns
List<E> rulesPackageArns

 The ARN(s) specifying the rules package(s) that you want to describe.
 


locale
String locale

 The locale that you want to translate a rules package description(s)
 into.
 








Class com.amazonaws.services.inspector.model.DescribeRulesPackagesResult extends Object implements Serializable




Serialized Fields


rulesPackages
List<E> rulesPackages

 Information about the rules package(s).
 


failedItems
Map<K,V> failedItems

 Rules package details that cannot be described. An error code is provided
 for each failed item.
 








Class com.amazonaws.services.inspector.model.DurationRange extends Object implements Serializable




Serialized Fields


minSeconds
Integer minSeconds

 The minimum value of the duration range. Must be greater than zero.
 


maxSeconds
Integer maxSeconds

 The maximum value of the duration range. Must be less than or equal to
 604800 seconds (1 week).
 








Class com.amazonaws.services.inspector.model.EventSubscription extends Object implements Serializable




Serialized Fields


event
String event

 The event for which Amazon Simple Notification Service (SNS)
 notifications are sent.
 


subscribedAt
Date subscribedAt

 The time at which the SubscribeToEvent API is called.
 








Class com.amazonaws.services.inspector.model.FailedItemDetails extends Object implements Serializable




Serialized Fields


failureCode
String failureCode

 The status code of a failed item.
 


retryable
Boolean retryable

 Indicates whether you can immediately retry a request for this item for a
 specified resource.
 








Class com.amazonaws.services.inspector.model.Finding extends Object implements Serializable




Serialized Fields


arn
String arn

 The ARN specifying the finding.
 


schemaVersion
Integer schemaVersion

 The schema version of this data type.
 


service
String service

 The data element is set to "Inspector".
 


serviceAttributes
InspectorServiceAttributes serviceAttributes


assetType
String assetType

 The type of the host from which the finding is generated.
 


assetAttributes
AssetAttributes assetAttributes

 A collection of attributes of the host from which the finding is
 generated.
 


id
String id

 The ID of the finding.
 


title
String title

 The name of the finding.
 


description
String description

 The description of the finding.
 


recommendation
String recommendation

 The recommendation for the finding.
 


severity
String severity

 The finding severity. Values can be set to High, Medium, Low, and
 Informational.
 


numericSeverity
Double numericSeverity

 

 The numeric value of the finding severity.
 
 


confidence
Integer confidence

 This data element is currently not used.
 


indicatorOfCompromise
Boolean indicatorOfCompromise

 This data element is currently not used.
 


attributes
List<E> attributes

 The system-defined attributes for the finding.
 


userAttributes
List<E> userAttributes

 The user-defined attributes that are assigned to the finding.
 


createdAt
Date createdAt

 The time when the finding was generated.
 


updatedAt
Date updatedAt

 The time when AddAttributesToFindings API is called.
 








Class com.amazonaws.services.inspector.model.FindingFilter extends Object implements Serializable




Serialized Fields


agentIds
List<E> agentIds

 For a record to match a filter, one of the values specified for this data
 type property must be the exact match of the value of the agentId
 property of the Finding data type.
 


autoScalingGroups
List<E> autoScalingGroups

 For a record to match a filter, one of the values specified for this data
 type property must be the exact match of the value of the
 autoScalingGroup property of the Finding data type.
 


ruleNames
List<E> ruleNames

 For a record to match a filter, one of the values specified for this data
 type property must be the exact match of the value of the ruleName
 property of the Finding data type.
 


severities
List<E> severities

 For a record to match a filter, one of the values specified for this data
 type property must be the exact match of the value of the severity
 property of the Finding data type.
 


rulesPackageArns
List<E> rulesPackageArns

 For a record to match a filter, one of the values specified for this data
 type property must be the exact match of the value of the
 rulesPackageArn property of the Finding data type.
 


attributes
List<E> attributes

 For a record to match a filter, the list of values specified for this
 data type property must be contained in the list of values of the
 attributes property of the Finding data type.
 


userAttributes
List<E> userAttributes

 For a record to match a filter, the value specified for this data type
 property must be contained in the list of values of the
 userAttributes property of the Finding data type.
 


creationTimeRange
TimestampRange creationTimeRange

 The time range during which the finding is generated.
 








Class com.amazonaws.services.inspector.model.GetTelemetryMetadataRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN specifying the assessment run the telemetry of which you want to
 obtain.
 








Class com.amazonaws.services.inspector.model.GetTelemetryMetadataResult extends Object implements Serializable




Serialized Fields


telemetryMetadata
List<E> telemetryMetadata

 Telemetry details.
 








Class com.amazonaws.services.inspector.model.InspectorServiceAttributes extends Object implements Serializable




Serialized Fields


schemaVersion
Integer schemaVersion

 The schema version of this data type.
 


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run during which the fidning is generated.
 


rulesPackageArn
String rulesPackageArn

 The ARN of the rules package used to generate the finding.
 








Class com.amazonaws.services.inspector.model.InternalException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.InvalidCrossAccountRoleException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode

 Code that indicates the type of error that is generated.
 


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode

 Code that indicates the type of error that is generated.
 


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode

 Code that indicates the type of error that is generated.
 


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.ListAssessmentRunAgentsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN specifying the assessment run whose agents you want to list.
 


filter
AgentFilter 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.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this
 parameter to 'null' on your first call to the
 ListAssessmentRunAgents action. Subsequent calls to the action
 fill nextToken in the request with the value of NextToken
 from previous response to continue listing data.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.ListAssessmentRunAgentsResult extends Object implements Serializable




Serialized Fields


assessmentRunAgents
List<E> assessmentRunAgents

 A list of ARNs specifying the agents returned by the action.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.ListAssessmentRunsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTemplateArns
List<E> assessmentTemplateArns

 ARN(s) specifying the assessment template(s) whose assessment run(s) you
 want to list.
 


filter
AssessmentRunFilter 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.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this
 parameter to 'null' on your first call to the ListAssessmentRuns
 action. Subsequent calls to the action fill nextToken in the
 request with the value of NextToken from previous response to
 continue listing data.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.ListAssessmentRunsResult extends Object implements Serializable




Serialized Fields


assessmentRunArns
List<E> assessmentRunArns

 A list of ARNs specifying the assessment run(s) returned by the action.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.ListAssessmentTargetsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


filter
AssessmentTargetFilter 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.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this
 parameter to 'null' on your first call to the
 ListAssessmentTargets action. Subsequent calls to the action fill
 nextToken in the request with the value of NextToken from
 previous response to continue listing data.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.ListAssessmentTargetsResult extends Object implements Serializable




Serialized Fields


assessmentTargetArns
List<E> assessmentTargetArns

 A list of ARNs specifying the assessment targets returned by the action.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.ListAssessmentTemplatesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTargetArns
List<E> assessmentTargetArns

 A list of ARN(s) specifying the assessment target(s) whose assessment
 template(s) you want to list.
 


filter
AssessmentTemplateFilter 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.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this
 parameter to 'null' on your first call to the
 ListAssessmentTemplates action. Subsequent calls to the action
 fill nextToken in the request with the value of NextToken
 from previous response to continue listing data.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.ListAssessmentTemplatesResult extends Object implements Serializable




Serialized Fields


assessmentTemplateArns
List<E> assessmentTemplateArns

 A list of ARN(s) specifying the assessment template(s) returned by the
 action.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.ListEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template for which you want to list the
 existing event subscriptions.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this
 parameter to 'null' on your first call to the
 ListEventSubscriptions action. Subsequent calls to the action fill
 nextToken in the request with the value of NextToken from
 previous response to continue listing data.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.ListEventSubscriptionsResult extends Object implements Serializable




Serialized Fields


subscriptions
List<E> subscriptions

 Details of the returned event subscriptions.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.ListFindingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentRunArns
List<E> assessmentRunArns

 The ARNs of the assessment run(s) that generate the findings that you
 want to list.
 


filter
FindingFilter 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.
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.ListFindingsResult extends Object implements Serializable




Serialized Fields


findingArns
List<E> findingArns

 A list of ARN(s) specifying the finding(s) returned by the action.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.ListRulesPackagesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.ListRulesPackagesResult extends Object implements Serializable




Serialized Fields


rulesPackageArns
List<E> rulesPackageArns

 The list of ARNs specifying the rules packages returned by the action.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceArn
String resourceArn

 The ARN specifying the assessment template whose tags you want to list.
 








Class com.amazonaws.services.inspector.model.ListTagsForResourceResult extends Object implements Serializable




Serialized Fields


tags
List<E> tags

 A collection of key and value pairs.
 








Class com.amazonaws.services.inspector.model.NoSuchEntityException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


errorCode
String errorCode

 Code that indicates the type of error that is generated.
 


canRetry
Boolean canRetry

 You can immediately retry your request.
 








Class com.amazonaws.services.inspector.model.PreviewAgentsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


previewAgentsArn
String previewAgentsArn

 The ARN of the assessment target whose agents you want to preview.
 


nextToken
String nextToken

 You can use this parameter when paginating results. Set the value of this
 parameter to 'null' on your first call to the PreviewAgents
 action. Subsequent calls to the action fill nextToken in the
 request with the value of NextToken from previous response to
 continue listing data.
 


maxResults
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.
 








Class com.amazonaws.services.inspector.model.PreviewAgentsResult extends Object implements Serializable




Serialized Fields


agentPreviews
List<E> agentPreviews

 The resulting list of agents.
 


nextToken
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'.
 








Class com.amazonaws.services.inspector.model.RegisterCrossAccountAccessRoleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that Inspector uses to list your EC2 instances
 during the assessment run or when you call the PreviewAgents
 action.
 








Class com.amazonaws.services.inspector.model.RemoveAttributesFromFindingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


findingArns
List<E> findingArns

 The ARNs specifying the findings that you want to remove attributes from.
 


attributeKeys
List<E> attributeKeys

 The array of attribute keys that you want to remove from specified
 findings.
 








Class com.amazonaws.services.inspector.model.RemoveAttributesFromFindingsResult extends Object implements Serializable




Serialized Fields


failedItems
Map<K,V> failedItems

 Attributes details that cannot be described. An error code is provided
 for each failed item.
 








Class com.amazonaws.services.inspector.model.ResourceGroup extends Object implements Serializable




Serialized Fields


arn
String arn

 The ARN of the resource group.
 


tags
List<E> tags

 The tags (key and value pairs) of the resource group. This data type
 property is used in the CreateResourceGroup action.
 


createdAt
Date createdAt

 The time at which resource group is created.
 








Class com.amazonaws.services.inspector.model.ResourceGroupTag extends Object implements Serializable




Serialized Fields


key
String key

 A tag key.
 


value
String value

 The value assigned to a tag key.
 








Class com.amazonaws.services.inspector.model.RulesPackage extends Object implements Serializable




Serialized Fields


arn
String arn

 The ARN of the rules package.
 


name
String name

 The name of the rules package.
 


version
String version

 The version id of the rules package.
 


provider
String provider

 The provider of the rules package.
 


description
String description

 The description of the rules package.
 








Class com.amazonaws.services.inspector.model.SetTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template that you want to set tags to.
 


tags
List<E> tags

 A collection of key and value pairs that you want to set to the
 assessment template.
 








Class com.amazonaws.services.inspector.model.StartAssessmentRunRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTemplateArn
String assessmentTemplateArn

 The assessment template ARN of the assessment run that you want to start.
 


assessmentRunName
String assessmentRunName

 You can specify the name for the assessment run, or it is auto-generated
 based on the assessment template name. Must be unique for the assessment
 template.
 








Class com.amazonaws.services.inspector.model.StartAssessmentRunResult extends Object implements Serializable




Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run that has been started.
 








Class com.amazonaws.services.inspector.model.StopAssessmentRunRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentRunArn
String assessmentRunArn

 The ARN of the assessment run that you want to stop.
 








Class com.amazonaws.services.inspector.model.SubscribeToEventRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template used during the event for which you
 want to recieve SNS notifications.
 


event
String event

 The event for which you want to receive SNS notifications.
 


topicArn
String topicArn

 The ARN of the SNS topic to which the SNS notifications are sent.
 








Class com.amazonaws.services.inspector.model.Subscription extends Object implements Serializable




Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template that is used during the event for
 which the SNS notification is sent.
 


topicArn
String topicArn

 The ARN of the Amazon Simple Notification Service (SNS) topic to which
 the SNS notifications are sent.
 


eventSubscriptions
List<E> eventSubscriptions

 The list of existing event subscriptions.
 








Class com.amazonaws.services.inspector.model.Tag extends Object implements Serializable




Serialized Fields


key
String key

 A tag key.
 


value
String value

 A value assigned to a tag key.
 








Class com.amazonaws.services.inspector.model.TelemetryMetadata extends Object implements Serializable




Serialized Fields


messageType
String messageType

 A specific type of behavioral data that is collected by the agent.
 


count
Long count

 The count of messages that the agent sends to the Inspector service.
 


dataSize
Long dataSize

 The data size of messages that the agent sends to the Inspector service.
 








Class com.amazonaws.services.inspector.model.TimestampRange extends Object implements Serializable




Serialized Fields


beginDate
Date beginDate

 The minimum value of the timestamp range.
 


endDate
Date endDate

 The maximum value of the timestamp range.
 








Class com.amazonaws.services.inspector.model.UnsubscribeFromEventRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceArn
String resourceArn

 The ARN of the assessment template used during the event for which you
 want to stop recieving SNS notifications.
 


event
String event

 The event for which you want to stop receiving SNS notifications.
 


topicArn
String topicArn

 The ARN of the SNS topic to which SNS notifications are sent.
 








Class com.amazonaws.services.inspector.model.UpdateAssessmentTargetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


assessmentTargetArn
String assessmentTargetArn

 The ARN of the assessment target that you want to update.
 


assessmentTargetName
String assessmentTargetName

 The name of the assessment target that you want to update.
 


resourceGroupArn
String resourceGroupArn

 The resource group ARN that is used to specify the new resource group to
 associate with the assessment target.
 








Package com.amazonaws.services.iot.model




Class com.amazonaws.services.iot.model.AcceptCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 


setAsActive
Boolean setAsActive

 Specifies whether the certificate is active.
 








Class com.amazonaws.services.iot.model.Action extends Object implements Serializable




Serialized Fields


dynamoDB
DynamoDBAction dynamoDB

 Write to a DynamoDB table.
 


lambda
LambdaAction lambda

 Invoke a Lambda function.
 


sns
SnsAction sns

 Publish to an Amazon SNS topic.
 


sqs
SqsAction sqs

 Publish to an Amazon SQS queue.
 


kinesis
KinesisAction kinesis

 Write data to an Amazon Kinesis stream.
 


republish
RepublishAction republish

 Publish to another MQTT topic.
 


s3
S3Action s3

 Write to an Amazon S3 bucket.
 


firehose
FirehoseAction firehose

 Write to an Amazon Kinesis Firehose stream.
 


cloudwatchMetric
CloudwatchMetricAction cloudwatchMetric

 Capture a CloudWatch metric.
 


cloudwatchAlarm
CloudwatchAlarmAction cloudwatchAlarm

 Change the state of a CloudWatch alarm.
 


elasticsearch
ElasticsearchAction elasticsearch

 Write data to an Amazon Elasticsearch Service; domain.
 








Class com.amazonaws.services.iot.model.AttachPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 


principal
String principal

 The principal, which can be a certificate ARN (as returned from the
 CreateCertificate operation) or an Amazon Cognito ID.
 








Class com.amazonaws.services.iot.model.AttachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 


principal
String principal

 The principal (certificate or other credential).
 








Class com.amazonaws.services.iot.model.AttachThingPrincipalResult extends Object implements Serializable




Class com.amazonaws.services.iot.model.AttributePayload extends Object implements Serializable




Serialized Fields


attributes
Map<K,V> attributes

 A JSON string containing up to three key-value pair in JSON format (for
 example, {\"attributes\":{\"string1\":\"string2\"}}).
 








Class com.amazonaws.services.iot.model.CACertificate extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn


certificateId
String certificateId


status
String status


creationDate
Date creationDate








Class com.amazonaws.services.iot.model.CACertificateDescription extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn


certificateId
String certificateId


status
String status


certificatePem
String certificatePem


ownedBy
String ownedBy


creationDate
Date creationDate








Class com.amazonaws.services.iot.model.CancelCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 








Class com.amazonaws.services.iot.model.Certificate extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn

 The ARN of the certificate.
 


certificateId
String certificateId

 The ID of the certificate.
 


status
String status

 The status of the certificate.
 


creationDate
Date creationDate

 The date and time the certificate was created.
 








Class com.amazonaws.services.iot.model.CertificateConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.CertificateDescription extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn

 The ARN of the certificate.
 


certificateId
String certificateId

 The ID of the certificate.
 


caCertificateId
String caCertificateId


status
String status

 The status of the certificate.
 


certificatePem
String certificatePem

 The certificate data, in PEM format.
 


ownedBy
String ownedBy

 The ID of the AWS account that owns the certificate.
 


previousOwnedBy
String previousOwnedBy


creationDate
Date creationDate

 The date and time the certificate was created.
 


lastModifiedDate
Date lastModifiedDate

 The date and time the certificate was last modified.
 


transferData
TransferData transferData








Class com.amazonaws.services.iot.model.CertificateStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.CertificateValidationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.CloudwatchAlarmAction extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The IAM role that allows access to the CloudWatch alarm.
 


alarmName
String alarmName

 The CloudWatch alarm name.
 


stateReason
String stateReason

 The reason for the alarm change.
 


stateValue
String stateValue

 The value of the alarm state. Acceptable values are: OK, ALARM,
 INSUFFICIENT_DATA.
 








Class com.amazonaws.services.iot.model.CloudwatchMetricAction extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The IAM role that allows access to the CloudWatch metric.
 


metricNamespace
String metricNamespace

 The CloudWatch metric namespace name.
 


metricName
String metricName

 The CloudWatch metric name.
 


metricValue
String metricValue

 The CloudWatch metric value.
 


metricUnit
String metricUnit

 The metric unit supported by CloudWatch.
 


metricTimestamp
String metricTimestamp

 An optional Unix timestamp.
 








Class com.amazonaws.services.iot.model.CreateCertificateFromCsrRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateSigningRequest
String certificateSigningRequest

 The certificate signing request (CSR).
 


setAsActive
Boolean setAsActive

 Specifies whether the certificate is active.
 








Class com.amazonaws.services.iot.model.CreateCertificateFromCsrResult extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn

 The Amazon Resource Name (ARN) of the certificate. You can use the ARN as
 a principal for policy operations.
 


certificateId
String certificateId

 The ID of the certificate. Certificate management operations only take a
 certificateId.
 


certificatePem
String certificatePem

 The certificate data, in PEM format.
 








Class com.amazonaws.services.iot.model.CreateKeysAndCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


setAsActive
Boolean setAsActive

 Specifies whether the certificate is active.
 








Class com.amazonaws.services.iot.model.CreateKeysAndCertificateResult extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn

 The ARN of the certificate.
 


certificateId
String certificateId

 The ID of the certificate. AWS IoT issues a default subject name for the
 certificate (for example, AWS IoT Certificate).
 


certificatePem
String certificatePem

 The certificate data, in PEM format.
 


keyPair
KeyPair keyPair

 The generated key pair.
 








Class com.amazonaws.services.iot.model.CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 


policyDocument
String policyDocument

 The JSON document that describes the policy. policyDocument must
 have a minimum length of 1, with a maximum length of 2048, excluding
 whitespace.
 








Class com.amazonaws.services.iot.model.CreatePolicyResult extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 


policyArn
String policyArn

 The policy ARN.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.CreatePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 


policyDocument
String policyDocument

 The JSON document that describes the policy. Minimum length of 1. Maximum
 length of 2048, excluding whitespaces
 


setAsDefault
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 to which the
 policy is attached).
 








Class com.amazonaws.services.iot.model.CreatePolicyVersionResult extends Object implements Serializable




Serialized Fields


policyArn
String policyArn

 The policy ARN.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is the default.
 








Class com.amazonaws.services.iot.model.CreateThingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 


attributePayload
AttributePayload attributePayload

 The attribute payload, which consists of up to 3 name/value pairs in a
 JSON document (for example, {\"attributes\":{\"string1\":\"string2\"}}).
 








Class com.amazonaws.services.iot.model.CreateThingResult extends Object implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 


thingArn
String thingArn

 The thing ARN.
 








Class com.amazonaws.services.iot.model.CreateTopicRuleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ruleName
String ruleName

 The name of the rule.
 


topicRulePayload
TopicRulePayload topicRulePayload

 The rule payload.
 








Class com.amazonaws.services.iot.model.DeleteCACertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId








Class com.amazonaws.services.iot.model.DeleteCACertificateResult extends Object implements Serializable




Class com.amazonaws.services.iot.model.DeleteCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 








Class com.amazonaws.services.iot.model.DeleteConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy to delete.
 








Class com.amazonaws.services.iot.model.DeletePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.DeleteRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.DeleteRegistrationCodeResult extends Object implements Serializable




Class com.amazonaws.services.iot.model.DeleteThingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The thing name.
 








Class com.amazonaws.services.iot.model.DeleteThingResult extends Object implements Serializable




Class com.amazonaws.services.iot.model.DeleteTopicRuleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ruleName
String ruleName

 The name of the rule.
 








Class com.amazonaws.services.iot.model.DescribeCACertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId








Class com.amazonaws.services.iot.model.DescribeCACertificateResult extends Object implements Serializable




Serialized Fields


certificateDescription
CACertificateDescription certificateDescription








Class com.amazonaws.services.iot.model.DescribeCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 








Class com.amazonaws.services.iot.model.DescribeCertificateResult extends Object implements Serializable




Serialized Fields


certificateDescription
CertificateDescription certificateDescription

 The description of the certificate.
 








Class com.amazonaws.services.iot.model.DescribeEndpointRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.DescribeEndpointResult extends Object implements Serializable




Serialized Fields


endpointAddress
String endpointAddress

 The endpoint. The format of the endpoint is as follows:
 identifier.iot.region.amazonaws.com.
 








Class com.amazonaws.services.iot.model.DescribeThingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iot.model.DescribeThingResult extends Object implements Serializable




Serialized Fields


defaultClientId
String defaultClientId

 The default client ID.
 


thingName
String thingName

 The name of the thing.
 


attributes
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\"}})
 








Class com.amazonaws.services.iot.model.DetachPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy to detach.
 


principal
String principal

 The principal.
 
 
 If the principal is a certificate, specify the certificate ARN. If the
 principal is an Amazon Cognito identity, specify the identity ID.
 








Class com.amazonaws.services.iot.model.DetachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 


principal
String principal

 The principal.
 








Class com.amazonaws.services.iot.model.DetachThingPrincipalResult extends Object implements Serializable




Class com.amazonaws.services.iot.model.DisableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ruleName
String ruleName

 The name of the rule to disable.
 








Class com.amazonaws.services.iot.model.DynamoDBAction extends Object implements Serializable




Serialized Fields


tableName
String tableName

 The name of the DynamoDB table.
 


roleArn
String roleArn

 The ARN of the IAM role that grants access to the DynamoDB table.
 


hashKeyField
String hashKeyField

 The hash key name.
 


hashKeyValue
String hashKeyValue

 The hash key value.
 


rangeKeyField
String rangeKeyField

 The range key name.
 


rangeKeyValue
String rangeKeyValue

 The range key value.
 


payloadField
String payloadField

 The action payload. This name can be customized.
 








Class com.amazonaws.services.iot.model.ElasticsearchAction extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The IAM role ARN that has access to Elasticsearch.
 


endpoint
String endpoint

 The endpoint of your Elasticsearch domain.
 


index
String index

 The Elasticsearch index where you want to store your data.
 


type
String type

 The type of document you are storing.
 


id
String id

 The unique identifier for the document you are storing.
 








Class com.amazonaws.services.iot.model.EnableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ruleName
String ruleName

 The name of the topic rule to enable.
 








Class com.amazonaws.services.iot.model.FirehoseAction extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The IAM role that grants access to the Amazon Kinesis Firehost stream.
 


deliveryStreamName
String deliveryStreamName

 The delivery stream name.
 








Class com.amazonaws.services.iot.model.GetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.GetLoggingOptionsResult extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


logLevel
String logLevel

 The logging level.
 








Class com.amazonaws.services.iot.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy.
 








Class com.amazonaws.services.iot.model.GetPolicyResult extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 


policyArn
String policyArn

 The policy ARN.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


defaultVersionId
String defaultVersionId

 The default policy version ID.
 








Class com.amazonaws.services.iot.model.GetPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The name of the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.GetPolicyVersionResult extends Object implements Serializable




Serialized Fields


policyArn
String policyArn

 The policy ARN.
 


policyName
String policyName

 The policy name.
 


policyDocument
String policyDocument

 The JSON document that describes the policy.
 


policyVersionId
String policyVersionId

 The policy version ID.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is the default.
 








Class com.amazonaws.services.iot.model.GetRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.iot.model.GetRegistrationCodeResult extends Object implements Serializable




Serialized Fields


registrationCode
String registrationCode








Class com.amazonaws.services.iot.model.GetTopicRuleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ruleName
String ruleName

 The name of the rule.
 








Class com.amazonaws.services.iot.model.GetTopicRuleResult extends Object implements Serializable




Serialized Fields


ruleArn
String ruleArn

 The rule ARN.
 


rule
TopicRule rule

 The rule.
 








Class com.amazonaws.services.iot.model.InternalException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.KeyPair extends Object implements Serializable




Serialized Fields


publicKey
String publicKey

 The public key.
 


privateKey
String privateKey

 The private key.
 








Class com.amazonaws.services.iot.model.KinesisAction extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access to the Amazon Kinesis stream.
 


streamName
String streamName

 The name of the Amazon Kinesis stream.
 


partitionKey
String partitionKey

 The partition key.
 








Class com.amazonaws.services.iot.model.LambdaAction extends Object implements Serializable




Serialized Fields


functionArn
String functionArn

 The ARN of the Lambda function.
 








Class com.amazonaws.services.iot.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.ListCACertificatesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pageSize
Integer pageSize


marker
String marker


ascendingOrder
Boolean ascendingOrder








Class com.amazonaws.services.iot.model.ListCACertificatesResult extends Object implements Serializable




Serialized Fields


certificates
List<E> certificates


nextMarker
String nextMarker








Class com.amazonaws.services.iot.model.ListCertificatesByCARequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


caCertificateId
String caCertificateId


pageSize
Integer pageSize


marker
String marker


ascendingOrder
Boolean ascendingOrder








Class com.amazonaws.services.iot.model.ListCertificatesByCAResult extends Object implements Serializable




Serialized Fields


certificates
List<E> certificates


nextMarker
String nextMarker








Class com.amazonaws.services.iot.model.ListCertificatesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


pageSize
Integer pageSize

 The result page size.
 


marker
String marker

 The marker for the next set of results.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If True, the results are returned in
 ascending order, based on the creation date.
 








Class com.amazonaws.services.iot.model.ListCertificatesResult extends Object implements Serializable




Serialized Fields


certificates
List<E> certificates

 The descriptions of the certificates.
 


nextMarker
String nextMarker

 The marker for the next set of results, or null if there are no
 additional results.
 








Class com.amazonaws.services.iot.model.ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


marker
String marker

 The marker for the next set of results.
 


pageSize
Integer pageSize

 The result page size.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If true, the results are returned in
 ascending creation order.
 








Class com.amazonaws.services.iot.model.ListPoliciesResult extends Object implements Serializable




Serialized Fields


policies
List<E> policies

 The descriptions of the policies.
 


nextMarker
String nextMarker

 The marker for the next set of results, or null if there are no
 additional results.
 








Class com.amazonaws.services.iot.model.ListPolicyVersionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 








Class com.amazonaws.services.iot.model.ListPolicyVersionsResult extends Object implements Serializable




Serialized Fields


policyVersions
List<E> policyVersions

 The policy versions.
 








Class com.amazonaws.services.iot.model.ListPrincipalPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


principal
String principal

 The principal.
 


marker
String marker

 The marker for the next set of results.
 


pageSize
Integer pageSize

 The result page size.
 


ascendingOrder
Boolean ascendingOrder

 Specifies the order for results. If true, results are returned in
 ascending creation order.
 








Class com.amazonaws.services.iot.model.ListPrincipalPoliciesResult extends Object implements Serializable




Serialized Fields


policies
List<E> policies

 The policies.
 


nextMarker
String nextMarker

 The marker for the next set of results, or null if there are no
 additional results.
 








Class com.amazonaws.services.iot.model.ListPrincipalThingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


nextToken
String nextToken

 A token used to retrieve the next value.
 


maxResults
Integer maxResults

 The maximum number of principals to return.
 


principal
String principal

 The principal.
 








Class com.amazonaws.services.iot.model.ListPrincipalThingsResult extends Object implements Serializable




Serialized Fields


things
List<E> things

 The things.
 


nextToken
String nextToken

 A token used to retrieve the next value.
 








Class com.amazonaws.services.iot.model.ListThingPrincipalsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iot.model.ListThingPrincipalsResult extends Object implements Serializable




Serialized Fields


principals
List<E> principals

 The principals.
 








Class com.amazonaws.services.iot.model.ListThingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


nextToken
String nextToken

 The token for the next value.
 


maxResults
Integer maxResults

 The maximum number of results.
 


attributeName
String attributeName

 The attribute name.
 


attributeValue
String attributeValue

 The attribute value.
 








Class com.amazonaws.services.iot.model.ListThingsResult extends Object implements Serializable




Serialized Fields


things
List<E> things

 The things.
 


nextToken
String nextToken

 A token used to retrieve the next value.
 








Class com.amazonaws.services.iot.model.ListTopicRulesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


topic
String topic

 The topic.
 


maxResults
Integer maxResults

 The maximum number of results to return.
 


nextToken
String nextToken

 A token used to retrieve the next value.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 








Class com.amazonaws.services.iot.model.ListTopicRulesResult extends Object implements Serializable




Serialized Fields


rules
List<E> rules

 The rules.
 


nextToken
String nextToken

 A token used to retrieve the next value.
 








Class com.amazonaws.services.iot.model.LoggingOptionsPayload extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


logLevel
String logLevel

 The logging level.
 








Class com.amazonaws.services.iot.model.MalformedPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.Policy extends Object implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 


policyArn
String policyArn

 The policy ARN.
 








Class com.amazonaws.services.iot.model.PolicyVersion extends Object implements Serializable




Serialized Fields


versionId
String versionId

 The policy version ID.
 


isDefaultVersion
Boolean isDefaultVersion

 Specifies whether the policy version is the default.
 


createDate
Date createDate

 The date and time the policy was created.
 








Class com.amazonaws.services.iot.model.RegisterCACertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


caCertificate
String caCertificate


verificationCertificate
String verificationCertificate


setAsActive
Boolean setAsActive








Class com.amazonaws.services.iot.model.RegisterCACertificateResult extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn


certificateId
String certificateId








Class com.amazonaws.services.iot.model.RegisterCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificatePem
String certificatePem


caCertificatePem
String caCertificatePem


setAsActive
Boolean setAsActive








Class com.amazonaws.services.iot.model.RegisterCertificateResult extends Object implements Serializable




Serialized Fields


certificateArn
String certificateArn


certificateId
String certificateId








Class com.amazonaws.services.iot.model.RegistrationCodeValidationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.RejectCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 


rejectReason
String rejectReason








Class com.amazonaws.services.iot.model.ReplaceTopicRuleRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ruleName
String ruleName

 The name of the rule.
 


topicRulePayload
TopicRulePayload topicRulePayload

 The rule payload.
 








Class com.amazonaws.services.iot.model.RepublishAction extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


topic
String topic

 The name of the MQTT topic.
 








Class com.amazonaws.services.iot.model.ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.S3Action extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


bucketName
String bucketName

 The Amazon S3 bucket.
 


key
String key

 The object key.
 








Class com.amazonaws.services.iot.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.SetDefaultPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policyName
String policyName

 The policy name.
 


policyVersionId
String policyVersionId

 The policy version ID.
 








Class com.amazonaws.services.iot.model.SetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


loggingOptionsPayload
LoggingOptionsPayload loggingOptionsPayload

 The logging options payload.
 








Class com.amazonaws.services.iot.model.SnsAction extends Object implements Serializable




Serialized Fields


targetArn
String targetArn

 The ARN of the SNS topic.
 


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


messageFormat
String messageFormat

 The message format of the message to publish. Optional. Accepted values
 are "JSON" and "RAW". The default value of the attribute is "RAW". SNS
 uses this setting to determine if the payload should be parsed and
 relevant platform-specific bits of the payload should be extracted. To
 read more about SNS message formats, see 
 refer to their official documentation.
 








Class com.amazonaws.services.iot.model.SqlParseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.SqsAction extends Object implements Serializable




Serialized Fields


roleArn
String roleArn

 The ARN of the IAM role that grants access.
 


queueUrl
String queueUrl

 The URL of the Amazon SQS queue.
 


useBase64
Boolean useBase64

 Specifies whether to use Base64 encoding.
 








Class com.amazonaws.services.iot.model.ThingAttribute extends Object implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 


attributes
Map<K,V> attributes

 The attributes.
 








Class com.amazonaws.services.iot.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.TopicRule extends Object implements Serializable




Serialized Fields


ruleName
String ruleName

 The name of the rule.
 


sql
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.
 


description
String description

 The description of the rule.
 


createdAt
Date createdAt

 The date and time the rule was created.
 


actions
List<E> actions

 The actions associated with the rule.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 








Class com.amazonaws.services.iot.model.TopicRuleListItem extends Object implements Serializable




Serialized Fields


ruleArn
String ruleArn

 The rule ARN.
 


ruleName
String ruleName

 The name of the rule.
 


topicPattern
String topicPattern

 The pattern for the topic names that apply.
 


createdAt
Date createdAt

 The date and time the rule was created.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 








Class com.amazonaws.services.iot.model.TopicRulePayload extends Object implements Serializable




Serialized Fields


sql
String sql

 The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide.
 


description
String description

 The description of the rule.
 


actions
List<E> actions

 The actions associated with the rule.
 


ruleDisabled
Boolean ruleDisabled

 Specifies whether the rule is disabled.
 








Class com.amazonaws.services.iot.model.TransferAlreadyCompletedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.TransferCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 


targetAwsAccount
String targetAwsAccount

 The AWS account.
 


transferMessage
String transferMessage








Class com.amazonaws.services.iot.model.TransferCertificateResult extends Object implements Serializable




Serialized Fields


transferredCertificateArn
String transferredCertificateArn

 The ARN of the certificate.
 








Class com.amazonaws.services.iot.model.TransferConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.TransferData extends Object implements Serializable




Serialized Fields


transferMessage
String transferMessage


rejectReason
String rejectReason


transferDate
Date transferDate


acceptDate
Date acceptDate


rejectDate
Date rejectDate








Class com.amazonaws.services.iot.model.UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iot.model.UpdateCACertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId


newStatus
String newStatus








Class com.amazonaws.services.iot.model.UpdateCertificateRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateId
String certificateId

 The ID of the certificate.
 


newStatus
String newStatus

 The new status.
 
 
 Note: Setting the status to PENDING_TRANSFER will result in an
 exception being thrown. PENDING_TRANSFER is a status used internally by
 AWS IoT. It is not intended for developer use.
 








Class com.amazonaws.services.iot.model.UpdateThingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The thing name.
 


attributePayload
AttributePayload attributePayload

 The attribute payload, a JSON string containing up to three key-value
 pairs (for example, {\"attributes\":{\"string1\":\"string2\"}}).
 








Class com.amazonaws.services.iot.model.UpdateThingResult extends Object implements Serializable




Class com.amazonaws.services.iot.model.VersionsLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.iotdata.model




Class com.amazonaws.services.iotdata.model.ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.DeleteThingShadowRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iotdata.model.DeleteThingShadowResult extends Object implements Serializable




Serialized Fields


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.GetThingShadowRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 








Class com.amazonaws.services.iotdata.model.GetThingShadowResult extends Object implements Serializable




Serialized Fields


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.MethodNotAllowedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.PublishRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


topic
String topic

 The name of the MQTT topic.
 


qos
Integer qos

 The Quality of Service (QoS) level.
 


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.RequestEntityTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.UnsupportedDocumentEncodingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.iotdata.model.UpdateThingShadowRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


thingName
String thingName

 The name of the thing.
 


payload
ByteBuffer payload

 The state information, in JSON format.
 








Class com.amazonaws.services.iotdata.model.UpdateThingShadowResult extends Object implements Serializable




Serialized Fields


payload
ByteBuffer payload

 The state information, in JSON format.
 








Package com.amazonaws.services.kinesis.model




Class com.amazonaws.services.kinesis.model.AddTagsToStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream.
 


tags
com.amazonaws.internal.SdkInternalMap<K,V> tags

 The set of key-value pairs to use to create the tags.
 








Class com.amazonaws.services.kinesis.model.CreateStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
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.
 


shardCount
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;
 








Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream to modify.
 


retentionPeriodHours
Integer retentionPeriodHours

 The new retention period of the stream, in hours. Must be less than the
 current retention period.
 








Class com.amazonaws.services.kinesis.model.DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream to delete.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream to describe.
 


limit
Integer limit

 The maximum number of shards to return.
 


exclusiveStartShardId
String exclusiveStartShardId

 The shard ID of the shard to start with.
 








Class com.amazonaws.services.kinesis.model.DescribeStreamResult extends Object implements Serializable




Serialized Fields


streamDescription
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.
 








Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the Amazon Kinesis stream for which to disable enhanced
 monitoring.
 


shardLevelMetrics
com.amazonaws.internal.SdkInternalList<T> shardLevelMetrics

 List of shard-level metrics to disable.
 
 
 The following are the valid shard-level metrics. The value "
 ALL" disables every metric.
 
 
  IncomingBytes
  IncomingRecords
  OutgoingBytes
  OutgoingRecords
  WriteProvisionedThroughputExceeded
  ReadProvisionedThroughputExceeded
  IteratorAgeMilliseconds
  ALL
 
 
 For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch
 in the Amazon Kinesis Streams Developer Guide.
 








Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringResult extends Object implements Serializable




Serialized Fields


streamName
String streamName

 The name of the Amazon Kinesis stream.
 


currentShardLevelMetrics
com.amazonaws.internal.SdkInternalList<T> currentShardLevelMetrics

 Represents the current state of the metrics that are in the enhanced
 state before the operation.
 


desiredShardLevelMetrics
com.amazonaws.internal.SdkInternalList<T> desiredShardLevelMetrics

 Represents the list of all the metrics that would be in the enhanced
 state after the operation.
 








Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream for which to enable enhanced monitoring.
 


shardLevelMetrics
com.amazonaws.internal.SdkInternalList<T> shardLevelMetrics

 List of shard-level metrics to enable.
 
 
 The following are the valid shard-level metrics. The value "
 ALL" enables every metric.
 
 
  IncomingBytes
  IncomingRecords
  OutgoingBytes
  OutgoingRecords
  WriteProvisionedThroughputExceeded
  ReadProvisionedThroughputExceeded
  IteratorAgeMilliseconds
  ALL
 
 
 For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch
 in the Amazon Kinesis Streams Developer Guide.
 








Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringResult extends Object implements Serializable




Serialized Fields


streamName
String streamName

 The name of the Amazon Kinesis stream.
 


currentShardLevelMetrics
com.amazonaws.internal.SdkInternalList<T> currentShardLevelMetrics

 Represents the current state of the metrics that are in the enhanced
 state before the operation.
 


desiredShardLevelMetrics
com.amazonaws.internal.SdkInternalList<T> desiredShardLevelMetrics

 Represents the list of all the metrics that would be in the enhanced
 state after the operation.
 








Class com.amazonaws.services.kinesis.model.EnhancedMetrics extends Object implements Serializable




Serialized Fields


shardLevelMetrics
com.amazonaws.internal.SdkInternalList<T> shardLevelMetrics

 List of shard-level metrics.
 
 
 The following are the valid shard-level metrics. The value "
 ALL" enhances every metric.
 
 
  IncomingBytes
  IncomingRecords
  OutgoingBytes
  OutgoingRecords
  WriteProvisionedThroughputExceeded
  ReadProvisionedThroughputExceeded
  IteratorAgeMilliseconds
  ALL
 
 
 For more information, see Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch
 in the Amazon Kinesis Streams Developer Guide.
 








Class com.amazonaws.services.kinesis.model.ExpiredIteratorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.GetRecordsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


shardIterator
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.
 


limit
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.
 








Class com.amazonaws.services.kinesis.model.GetRecordsResult extends Object implements Serializable




Serialized Fields


records
com.amazonaws.internal.SdkInternalList<T> records

 The data records retrieved from the shard.
 


nextShardIterator
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.
 


millisBehindLatest
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.
 








Class com.amazonaws.services.kinesis.model.GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the Amazon Kinesis stream.
 


shardId
String shardId

 The shard ID of the Amazon Kinesis shard to get the iterator for.
 


shardIteratorType
String shardIteratorType

 Determines how the shard iterator is used to start reading data records
 from the shard.
 
 
 The following are the valid Amazon Kinesis shard iterator types:
 
 
 AT_SEQUENCE_NUMBER - Start reading from the position denoted by a
 specific sequence number, provided in the value
 StartingSequenceNumber.
 AFTER_SEQUENCE_NUMBER - Start reading right after the position
 denoted by a specific sequence number, provided in the value
 StartingSequenceNumber.
 AT_TIMESTAMP - Start reading from the position denoted by a specific
 timestamp, provided in the value Timestamp.
 TRIM_HORIZON - Start reading at the last untrimmed record in the
 shard in the system, which is the oldest data record in the shard.
 LATEST - Start reading just after the most recent record in the
 shard, so that you always read the most recent data in the shard.
 


startingSequenceNumber
String startingSequenceNumber

 The sequence number of the data record in the shard from which to start
 reading. Used with shard iterator type AT_SEQUENCE_NUMBER and
 AFTER_SEQUENCE_NUMBER.
 


timestamp
Date timestamp

 The timestamp of the data record from which to start reading. Used with
 shard iterator type AT_TIMESTAMP. A timestamp is the Unix epoch date with
 precision in milliseconds. For example,
 2016-04-04T19:58:46.480-00:00 or 1459799926.480
 . If a record with this exact timestamp does not exist, the iterator
 returned is for the next (later) record. If the timestamp is older than
 the current trim horizon, the iterator returned is for the oldest
 untrimmed data record (TRIM_HORIZON).
 








Class com.amazonaws.services.kinesis.model.GetShardIteratorResult extends Object implements Serializable




Serialized Fields


shardIterator
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.
 








Class com.amazonaws.services.kinesis.model.HashKeyRange extends Object implements Serializable




Serialized Fields


startingHashKey
String startingHashKey

 The starting hash key of the hash key range.
 


endingHashKey
String endingHashKey

 The ending hash key of the hash key range.
 








Class com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream to modify.
 


retentionPeriodHours
Integer retentionPeriodHours

 The new retention period of the stream, in hours. Must be more than the
 current retention period.
 








Class com.amazonaws.services.kinesis.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.ListStreamsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


limit
Integer limit

 The maximum number of streams to list.
 


exclusiveStartStreamName
String exclusiveStartStreamName

 The name of the stream to start the list with.
 








Class com.amazonaws.services.kinesis.model.ListStreamsResult extends Object implements Serializable




Serialized Fields


streamNames
com.amazonaws.internal.SdkInternalList<T> streamNames

 The names of the streams that are associated with the AWS account making
 the ListStreams request.
 


hasMoreStreams
Boolean hasMoreStreams

 If set to true, there are more streams available to list.
 








Class com.amazonaws.services.kinesis.model.ListTagsForStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream.
 


exclusiveStartTagKey
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.
 


limit
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.
 








Class com.amazonaws.services.kinesis.model.ListTagsForStreamResult extends Object implements Serializable




Serialized Fields


tags
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.
 


hasMoreTags
Boolean hasMoreTags

 If set to true, more tags are available. To request
 additional tags, set ExclusiveStartTagKey to the key of the
 last tag returned.
 








Class com.amazonaws.services.kinesis.model.MergeShardsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream for the merge.
 


shardToMerge
String shardToMerge

 The shard ID of the shard to combine with the adjacent shard for the
 merge.
 


adjacentShardToMerge
String adjacentShardToMerge

 The shard ID of the adjacent shard for the merge.
 








Class com.amazonaws.services.kinesis.model.ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.PutRecordRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream to put the data record into.
 


data
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).
 


partitionKey
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.
 


explicitHashKey
String explicitHashKey

 The hash value used to explicitly determine the shard the data record is
 assigned to by overriding the partition key hash.
 


sequenceNumberForOrdering
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.
 








Class com.amazonaws.services.kinesis.model.PutRecordResult extends Object implements Serializable




Serialized Fields


shardId
String shardId

 The shard ID of the shard where the data record was placed.
 


sequenceNumber
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.
 








Class com.amazonaws.services.kinesis.model.PutRecordsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


records
com.amazonaws.internal.SdkInternalList<T> records

 The records associated with the request.
 


streamName
String streamName

 The stream name associated with the request.
 








Class com.amazonaws.services.kinesis.model.PutRecordsRequestEntry extends Object implements Serializable




Serialized Fields


data
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).
 


explicitHashKey
String explicitHashKey

 The hash value used to determine explicitly the shard that the data
 record is assigned to by overriding the partition key hash.
 


partitionKey
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.
 








Class com.amazonaws.services.kinesis.model.PutRecordsResult extends Object implements Serializable




Serialized Fields


failedRecordCount
Integer failedRecordCount

 The number of unsuccessfully processed records in a
 PutRecords request.
 


records
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 a stream includes SequenceNumber and
 ShardId in the result. A record that fails to be added to a
 stream includes ErrorCode and ErrorMessage in
 the result.
 








Class com.amazonaws.services.kinesis.model.PutRecordsResultEntry extends Object implements Serializable




Serialized Fields


sequenceNumber
String sequenceNumber

 The sequence number for an individual record result.
 


shardId
String shardId

 The shard ID for an individual record result.
 


errorCode
String errorCode

 The error code for an individual record result. ErrorCodes
 can be either ProvisionedThroughputExceededException or
 InternalFailure.
 


errorMessage
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".
 








Class com.amazonaws.services.kinesis.model.Record extends Object implements Serializable




Serialized Fields


sequenceNumber
String sequenceNumber

 The unique identifier of the record in the stream.
 


approximateArrivalTimestamp
Date approximateArrivalTimestamp

 The approximate time that the record was inserted into the stream.
 


data
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).
 


partitionKey
String partitionKey

 Identifies which shard in the stream the data record is assigned to.
 








Class com.amazonaws.services.kinesis.model.RemoveTagsFromStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream.
 


tagKeys
com.amazonaws.internal.SdkInternalList<T> tagKeys

 A list of tag keys. Each corresponding tag is removed from the stream.
 








Class com.amazonaws.services.kinesis.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesis.model.SequenceNumberRange extends Object implements Serializable




Serialized Fields


startingSequenceNumber
String startingSequenceNumber

 The starting sequence number for the range.
 


endingSequenceNumber
String endingSequenceNumber

 The ending sequence number for the range. Shards that are in the OPEN
 state have an ending sequence number of null.
 








Class com.amazonaws.services.kinesis.model.Shard extends Object implements Serializable




Serialized Fields


shardId
String shardId

 The unique identifier of the shard within the stream.
 


parentShardId
String parentShardId

 The shard ID of the shard's parent.
 


adjacentParentShardId
String adjacentParentShardId

 The shard ID of the shard adjacent to the shard's parent.
 


hashKeyRange
HashKeyRange hashKeyRange

 The range of possible hash key values for the shard, which is a set of
 ordered contiguous positive integers.
 


sequenceNumberRange
SequenceNumberRange sequenceNumberRange

 The range of possible sequence numbers for the shard.
 








Class com.amazonaws.services.kinesis.model.SplitShardRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream for the shard split.
 


shardToSplit
String shardToSplit

 The shard ID of the shard to split.
 


newStartingHashKey
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.
 








Class com.amazonaws.services.kinesis.model.StreamDescription extends Object implements Serializable




Serialized Fields


streamName
String streamName

 The name of the stream being described.
 


streamARN
String streamARN

 The Amazon Resource Name (ARN) for the stream being described.
 


streamStatus
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.
 


shards
com.amazonaws.internal.SdkInternalList<T> shards

 The shards that comprise the stream.
 


hasMoreShards
Boolean hasMoreShards

 If set to true, more shards in the stream are available to
 describe.
 


retentionPeriodHours
Integer retentionPeriodHours

 The current retention period, in hours.
 


enhancedMonitoring
com.amazonaws.internal.SdkInternalList<T> enhancedMonitoring

 Represents the current enhanced monitoring settings of the stream.
 








Class com.amazonaws.services.kinesis.model.Tag extends Object implements Serializable




Serialized Fields


key
String key

 A unique identifier for the tag. Maximum length: 128 characters. Valid
 characters: Unicode letters, digits, white space, _ . / = + - % @
 


value
String value

 An optional string, typically used to describe or define the tag. Maximum
 length: 256 characters. Valid characters: Unicode letters, digits, white
 space, _ . / = + - % @
 








Package com.amazonaws.services.kinesisfirehose.model




Class com.amazonaws.services.kinesisfirehose.model.BufferingHints extends Object implements Serializable




Serialized Fields


sizeInMBs
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.
 


intervalInSeconds
Integer intervalInSeconds

 Buffer incoming data for the specified period of time, in seconds, before
 delivering it to the destination. The default value is 300.
 








Class com.amazonaws.services.kinesisfirehose.model.CloudWatchLoggingOptions extends Object implements Serializable




Serialized Fields


enabled
Boolean enabled

 Enables or disables CloudWatch logging.
 


logGroupName
String logGroupName

 The CloudWatch group name for logging. This value is required if Enabled
 is true.
 


logStreamName
String logStreamName

 The CloudWatch log stream name for logging. This value is required if
 Enabled is true.
 








Class com.amazonaws.services.kinesisfirehose.model.ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.CopyCommand extends Object implements Serializable




Serialized Fields


dataTableName
String dataTableName

 The name of the target table. The table must already exist in the
 database.
 


dataTableColumns
String dataTableColumns

 A comma-separated list of column names.
 


copyOptions
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
 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 Amazon Redshift COPY command examples.
 








Class com.amazonaws.services.kinesisfirehose.model.CreateDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


s3DestinationConfiguration
S3DestinationConfiguration s3DestinationConfiguration

 The destination in Amazon S3. This value must be specified if
 ElasticsearchDestinationConfiguration or
 RedshiftDestinationConfiguration is specified (see restrictions
 listed above).
 


redshiftDestinationConfiguration
RedshiftDestinationConfiguration redshiftDestinationConfiguration

 The destination in Amazon Redshift. This value cannot be specified if
 Amazon S3 or Amazon Elasticsearch is the desired destination (see
 restrictions listed above).
 


elasticsearchDestinationConfiguration
ElasticsearchDestinationConfiguration elasticsearchDestinationConfiguration

 The destination in Amazon ES. This value cannot be specified if Amazon S3
 or Amazon Redshift is the desired destination (see restrictions listed
 above).
 








Class com.amazonaws.services.kinesisfirehose.model.CreateDeliveryStreamResult extends Object implements Serializable




Serialized Fields


deliveryStreamARN
String deliveryStreamARN

 The ARN of the delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.DeleteDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.DeleteDeliveryStreamResult extends Object implements Serializable




Class com.amazonaws.services.kinesisfirehose.model.DeliveryStreamDescription extends Object implements Serializable




Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


deliveryStreamARN
String deliveryStreamARN

 The Amazon Resource Name (ARN) of the delivery stream.
 


deliveryStreamStatus
String deliveryStreamStatus

 The status of the delivery stream.
 


versionId
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.
 


createTimestamp
Date createTimestamp

 The date and time that the delivery stream was created.
 


lastUpdateTimestamp
Date lastUpdateTimestamp

 The date and time that the delivery stream was last updated.
 


destinations
List<E> destinations

 The destinations.
 


hasMoreDestinations
Boolean hasMoreDestinations

 Indicates whether there are more destinations available to list.
 








Class com.amazonaws.services.kinesisfirehose.model.DescribeDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


limit
Integer limit

 The limit on the number of destinations to return. Currently, you can
 have one destination per delivery stream.
 


exclusiveStartDestinationId
String exclusiveStartDestinationId

 Specifies the destination ID to start returning the destination
 information. Currently Firehose supports one destination per delivery
 stream.
 








Class com.amazonaws.services.kinesisfirehose.model.DescribeDeliveryStreamResult extends Object implements Serializable




Serialized Fields


deliveryStreamDescription
DeliveryStreamDescription deliveryStreamDescription

 Information about the delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.DestinationDescription extends Object implements Serializable




Serialized Fields


destinationId
String destinationId

 The ID of the destination.
 


s3DestinationDescription
S3DestinationDescription s3DestinationDescription

 The Amazon S3 destination.
 


redshiftDestinationDescription
RedshiftDestinationDescription redshiftDestinationDescription

 The destination in Amazon Redshift.
 


elasticsearchDestinationDescription
ElasticsearchDestinationDescription elasticsearchDestinationDescription

 The destination in Amazon ES.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchBufferingHints extends Object implements Serializable




Serialized Fields


intervalInSeconds
Integer intervalInSeconds

 Buffer incoming data for the specified period of time, in seconds, before
 delivering it to the destination. The default value is 300 (5 minutes).
 


sizeInMBs
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.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationConfiguration extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the IAM role to be assumed by Firehose for calling the Amazon
 ES Configuration API and for indexing documents. For more information,
 see Amazon S3 Bucket Access.
 


domainARN
String domainARN

 The ARN of the Amazon ES domain. The IAM role must have permission for 
 DescribeElasticsearchDomain,
 DescribeElasticsearchDomains , and
 DescribeElasticsearchDomainConfig after assuming
 RoleARN.
 


indexName
String indexName

 The Elasticsearch index name.
 


typeName
String typeName

 The Elasticsearch type name.
 


indexRotationPeriod
String indexRotationPeriod

 The Elasticsearch index rotation period. Index rotation appends a
 timestamp to the IndexName to facilitate expiration of old data. For more
 information, see Index Rotation for Amazon Elasticsearch Service Destination. Default
 value is OneDay.
 


bufferingHints
ElasticsearchBufferingHints bufferingHints

 Buffering options. If no value is specified,
 ElasticsearchBufferingHints object default values are used.
 


retryOptions
ElasticsearchRetryOptions retryOptions

 Configures retry behavior in the event that Firehose is unable to deliver
 documents to Amazon ES. Default value is 300 (5 minutes).
 


s3BackupMode
String s3BackupMode

 Defines how documents should be delivered to Amazon S3. When set to
 FailedDocumentsOnly, Firehose writes any documents that could not be
 indexed to the configured Amazon S3 destination, with
 elasticsearch-failed/ appended to the key prefix. When set to
 AllDocuments, Firehose delivers all incoming records to Amazon S3, and
 also writes failed documents with elasticsearch-failed/ appended to the
 prefix. For more information, see Amazon S3 Backup for Amazon Elasticsearch Service Destination.
 Default value is FailedDocumentsOnly.
 


s3Configuration
S3DestinationConfiguration s3Configuration


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationDescription extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the AWS credentials.
 


domainARN
String domainARN

 The ARN of the Amazon ES domain.
 


indexName
String indexName

 The Elasticsearch index name.
 


typeName
String typeName

 The Elasticsearch type name.
 


indexRotationPeriod
String indexRotationPeriod

 The Elasticsearch index rotation period
 


bufferingHints
ElasticsearchBufferingHints bufferingHints

 Buffering options.
 


retryOptions
ElasticsearchRetryOptions retryOptions

 Elasticsearch retry options.
 


s3BackupMode
String s3BackupMode

 Amazon S3 backup mode.
 


s3DestinationDescription
S3DestinationDescription s3DestinationDescription


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 CloudWatch logging options.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationUpdate extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the IAM role to be assumed by Firehose for calling the Amazon
 ES Configuration API and for indexing documents. For more information,
 see Amazon S3 Bucket Access.
 


domainARN
String domainARN

 The ARN of the Amazon ES domain. The IAM role must have permission
 for DescribeElasticsearchDomain, DescribeElasticsearchDomains , and
 DescribeElasticsearchDomainConfig after assuming RoleARN.
 


indexName
String indexName

 The Elasticsearch index name.
 


typeName
String typeName

 The Elasticsearch type name.
 


indexRotationPeriod
String indexRotationPeriod

 The Elasticsearch index rotation period. Index rotation appends a
 timestamp to the IndexName to facilitate the expiration of old data. For
 more information, see Index Rotation for Amazon Elasticsearch Service Destination. Default
 value is OneDay.
 


bufferingHints
ElasticsearchBufferingHints bufferingHints

 Buffering options. If no value is specified,
 ElasticsearchBufferingHints object default values are used.
 


retryOptions
ElasticsearchRetryOptions retryOptions

 Configures retry behavior in the event that Firehose is unable to deliver
 documents to Amazon ES. Default value is 300 (5 minutes).
 


s3Update
S3DestinationUpdate s3Update


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchRetryOptions extends Object implements Serializable




Serialized Fields


durationInSeconds
Integer durationInSeconds

 After an initial failure to deliver to Amazon ES, the total amount of
 time during which Firehose re-attempts delivery. After this time has
 elapsed, the failed documents are written to Amazon S3. Default value is
 300 seconds. A value of 0 (zero) results in no retries.
 








Class com.amazonaws.services.kinesisfirehose.model.EncryptionConfiguration extends Object implements Serializable




Serialized Fields


noEncryptionConfig
String noEncryptionConfig

 Specifically override existing encryption information to ensure no
 encryption is used.
 


kMSEncryptionConfig
KMSEncryptionConfig kMSEncryptionConfig

 The encryption key.
 








Class com.amazonaws.services.kinesisfirehose.model.InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.KMSEncryptionConfig extends Object implements Serializable




Serialized Fields


aWSKMSKeyARN
String aWSKMSKeyARN

 The ARN of the encryption key. Must belong to the same region as the
 destination Amazon S3 bucket.
 








Class com.amazonaws.services.kinesisfirehose.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.ListDeliveryStreamsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


limit
Integer limit

 The maximum number of delivery streams to list.
 


exclusiveStartDeliveryStreamName
String exclusiveStartDeliveryStreamName

 The name of the delivery stream to start the list with.
 








Class com.amazonaws.services.kinesisfirehose.model.ListDeliveryStreamsResult extends Object implements Serializable




Serialized Fields


deliveryStreamNames
List<E> deliveryStreamNames

 The names of the delivery streams.
 


hasMoreDeliveryStreams
Boolean hasMoreDeliveryStreams

 Indicates whether there are more delivery streams available to list.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


records
List<E> records

 One or more records.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResponseEntry extends Object implements Serializable




Serialized Fields


recordId
String recordId

 The ID of the record.
 


errorCode
String errorCode

 The error code for an individual record result.
 


errorMessage
String errorMessage

 The error message for an individual record result.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResult extends Object implements Serializable




Serialized Fields


failedPutCount
Integer failedPutCount

 The number of unsuccessfully written records.
 


requestResponses
List<E> requestResponses

 The results for the individual records. The index of each element matches
 the same index in which records were sent.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


record
Record record

 The record.
 








Class com.amazonaws.services.kinesisfirehose.model.PutRecordResult extends Object implements Serializable




Serialized Fields


recordId
String recordId

 The ID of the record.
 








Class com.amazonaws.services.kinesisfirehose.model.Record extends Object implements Serializable




Serialized Fields


data
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.
 








Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationConfiguration extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the AWS credentials.
 


clusterJDBCURL
String clusterJDBCURL

 The database connection string.
 


copyCommand
CopyCommand copyCommand

 The COPY command.
 


username
String username

 The name of the user.
 


password
String password

 The user password.
 


s3Configuration
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.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationDescription extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the AWS credentials.
 


clusterJDBCURL
String clusterJDBCURL

 The database connection string.
 


copyCommand
CopyCommand copyCommand

 The COPY command.
 


username
String username

 The name of the user.
 


s3DestinationDescription
S3DestinationDescription s3DestinationDescription

 The Amazon S3 destination.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationUpdate extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the AWS credentials.
 


clusterJDBCURL
String clusterJDBCURL

 The database connection string.
 


copyCommand
CopyCommand copyCommand

 The COPY command.
 


username
String username

 The name of the user.
 


password
String password

 The user password.
 


s3Update
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.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.S3DestinationConfiguration extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the AWS credentials.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket.
 


prefix
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 bufferingHints

 The buffering option. If no value is specified, BufferingHints
 object default values are used.
 


compressionFormat
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 encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no
 encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.S3DestinationDescription extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the AWS credentials.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket.
 


prefix
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 bufferingHints

 The buffering option. If no value is specified, BufferingHints
 object default values are used.
 


compressionFormat
String compressionFormat

 The compression format. If no value is specified, the default is
 NOCOMPRESSION.
 


encryptionConfiguration
EncryptionConfiguration encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no
 encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.S3DestinationUpdate extends Object implements Serializable




Serialized Fields


roleARN
String roleARN

 The ARN of the AWS credentials.
 


bucketARN
String bucketARN

 The ARN of the S3 bucket.
 


prefix
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 bufferingHints

 The buffering option. If no value is specified, BufferingHints
 object default values are used.
 


compressionFormat
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 encryptionConfiguration

 The encryption configuration. If no value is specified, the default is no
 encryption.
 


cloudWatchLoggingOptions
CloudWatchLoggingOptions cloudWatchLoggingOptions

 Describes CloudWatch logging options for your delivery stream.
 








Class com.amazonaws.services.kinesisfirehose.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kinesisfirehose.model.UpdateDestinationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


deliveryStreamName
String deliveryStreamName

 The name of the delivery stream.
 


currentDeliveryStreamVersionId
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.
 


destinationId
String destinationId

 The ID of the destination.
 


s3DestinationUpdate
S3DestinationUpdate s3DestinationUpdate


redshiftDestinationUpdate
RedshiftDestinationUpdate redshiftDestinationUpdate


elasticsearchDestinationUpdate
ElasticsearchDestinationUpdate elasticsearchDestinationUpdate

 Describes an update for a destination in Amazon ES.
 








Class com.amazonaws.services.kinesisfirehose.model.UpdateDestinationResult extends Object implements Serializable




Package com.amazonaws.services.kms.model




Class com.amazonaws.services.kms.model.AliasListEntry extends Object implements Serializable




Serialized Fields


aliasName
String aliasName

 String that contains the alias.
 


aliasArn
String aliasArn

 String that contains the key ARN.
 


targetKeyId
String targetKeyId

 String that contains the key identifier pointed to by the alias.
 








Class com.amazonaws.services.kms.model.AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.CancelKeyDeletionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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:
 

 Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-
 56ef-1234567890ab
 
 
 
 To obtain the unique key ID and key ARN for a given CMK, use
 ListKeys or DescribeKey.
 








Class com.amazonaws.services.kms.model.CancelKeyDeletionResult extends Object implements Serializable




Serialized Fields


keyId
String keyId

 The unique identifier of the master key for which deletion is canceled.
 








Class com.amazonaws.services.kms.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aliasName
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.
 


targetKeyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 








Class com.amazonaws.services.kms.model.CreateGrantRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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:
 

 Globally unique key ID: 12345678-1234-1234-1234-123456789012
 Key ARN:
 arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234
 -123456789012
 
 


granteePrincipal
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.
 


retiringPrincipal
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.
 


operations
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:
 

 Decrypt
 Encrypt
 GenerateDataKey
 GenerateDataKeyWithoutPlaintext
 ReEncryptFrom
 ReEncryptTo
 CreateGrant
 RetireGrant
 
 


constraints
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.
 


grantTokens
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.
 


name
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.
 








Class com.amazonaws.services.kms.model.CreateGrantResult extends Object implements Serializable




Serialized Fields


grantToken
String grantToken

 The grant token.
 
 
 For more information about using grant tokens, see Grant Tokens in the AWS Key Management Service Developer
 Guide.
 


grantId
String grantId

 The unique identifier for the grant.
 
 
 You can use the GrantId in a subsequent RetireGrant
 or RevokeGrant operation.
 








Class com.amazonaws.services.kms.model.CreateKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


policy
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).
 


description
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.
 


keyUsage
String keyUsage

 Specifies the intended use of the key. Currently this defaults to
 ENCRYPT/DECRYPT, and only symmetric encryption and decryption are
 supported.
 








Class com.amazonaws.services.kms.model.CreateKeyResult extends Object implements Serializable




Serialized Fields


keyMetadata
KeyMetadata keyMetadata

 Metadata associated with the key.
 








Class com.amazonaws.services.kms.model.DecryptRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 Ciphertext to be decrypted. The blob includes metadata.
 


encryptionContext
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.
 


grantTokens
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.
 








Class com.amazonaws.services.kms.model.DecryptResult extends Object implements Serializable




Serialized Fields


keyId
String keyId

 ARN of the key used to perform the decryption. This value is returned if
 no errors are encountered during the operation.
 


plaintext
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.
 








Class com.amazonaws.services.kms.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aliasName
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.
 








Class com.amazonaws.services.kms.model.DependencyTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.DescribeKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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/".
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Alias ARN Example -
 arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 Alias Name Example - alias/MyAliasName
 
 


grantTokens
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.
 








Class com.amazonaws.services.kms.model.DescribeKeyResult extends Object implements Serializable




Serialized Fields


keyMetadata
KeyMetadata keyMetadata

 Metadata associated with the key.
 








Class com.amazonaws.services.kms.model.DisabledException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.DisableKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 








Class com.amazonaws.services.kms.model.DisableKeyRotationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 








Class com.amazonaws.services.kms.model.EnableKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 








Class com.amazonaws.services.kms.model.EnableKeyRotationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 








Class com.amazonaws.services.kms.model.EncryptRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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/".
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Alias ARN Example -
 arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 Alias Name Example - alias/MyAliasName
 
 


plaintext
ByteBuffer plaintext

 Data to be encrypted.
 


encryptionContext
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.
 


grantTokens
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.
 








Class com.amazonaws.services.kms.model.EncryptResult extends Object implements Serializable




Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 The encrypted plaintext. If you are using the CLI, the value is Base64
 encoded. Otherwise, it is not encoded.
 


keyId
String keyId

 The ID of the key used during encryption.
 








Class com.amazonaws.services.kms.model.GenerateDataKeyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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/".
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Alias ARN Example -
 arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 Alias Name Example - alias/MyAliasName
 
 


encryptionContext
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.
 


numberOfBytes
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.
 


keySpec
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.
 


grantTokens
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.
 








Class com.amazonaws.services.kms.model.GenerateDataKeyResult extends Object implements Serializable




Serialized Fields


ciphertextBlob
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.
 


plaintext
ByteBuffer plaintext

 Plaintext that contains the data key. Use this for encryption and
 decryption and then remove it from memory as soon as possible.
 


keyId
String keyId

 System generated unique identifier of the key to be used to decrypt the
 encrypted copy of the data key.
 








Class com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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/".
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Alias ARN Example -
 arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 Alias Name Example - alias/MyAliasName
 
 


encryptionContext
com.amazonaws.internal.SdkInternalMap<K,V> encryptionContext

 Name:value pair that contains additional data to be authenticated during
 the encryption and decryption processes.
 


keySpec
String keySpec

 Value that identifies the encryption algorithm and key size. Currently
 this can be AES_128 or AES_256.
 


numberOfBytes
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.
 


grantTokens
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.
 








Class com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextResult extends Object implements Serializable




Serialized Fields


ciphertextBlob
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.
 


keyId
String keyId

 System generated unique identifier of the key to be used to decrypt the
 encrypted copy of the data key.
 








Class com.amazonaws.services.kms.model.GenerateRandomRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


numberOfBytes
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.
 








Class com.amazonaws.services.kms.model.GenerateRandomResult extends Object implements Serializable




Serialized Fields


plaintext
ByteBuffer plaintext

 Plaintext that contains the unpredictable byte string.
 








Class com.amazonaws.services.kms.model.GetKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 


policyName
String policyName

 String that contains the name of the policy. Currently, this must be
 "default". Policy names can be discovered by calling
 ListKeyPolicies.
 








Class com.amazonaws.services.kms.model.GetKeyPolicyResult extends Object implements Serializable




Serialized Fields


policy
String policy

 A policy document in JSON format.
 








Class com.amazonaws.services.kms.model.GetKeyRotationStatusRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 








Class com.amazonaws.services.kms.model.GetKeyRotationStatusResult extends Object implements Serializable




Serialized Fields


keyRotationEnabled
Boolean keyRotationEnabled

 A Boolean value that specifies whether key rotation is enabled.
 








Class com.amazonaws.services.kms.model.GrantConstraints extends Object implements Serializable




Serialized Fields


encryptionContextSubset
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.
 


encryptionContextEquals
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.
 








Class com.amazonaws.services.kms.model.GrantListEntry extends Object implements Serializable




Serialized Fields


keyId
String keyId

 The unique identifier for the customer master key (CMK) to which the
 grant applies.
 


grantId
String grantId

 The unique identifier for the grant.
 


name
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.
 


creationDate
Date creationDate

 The date and time when the grant was created.
 


granteePrincipal
String granteePrincipal

 The principal that receives the grant's permissions.
 


retiringPrincipal
String retiringPrincipal

 The principal that can retire the grant.
 


issuingAccount
String issuingAccount

 The AWS account under which the grant was issued.
 


operations
com.amazonaws.internal.SdkInternalList<T> operations

 The list of operations permitted by the grant.
 


constraints
GrantConstraints constraints

 The conditions under which the grant's operations are allowed.
 








Class com.amazonaws.services.kms.model.InvalidAliasNameException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidArnException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidCiphertextException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidGrantIdException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidGrantTokenException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidKeyUsageException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.InvalidMarkerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.KeyListEntry extends Object implements Serializable




Serialized Fields


keyId
String keyId

 Unique identifier of the key.
 


keyArn
String keyArn

 ARN of the key.
 








Class com.amazonaws.services.kms.model.KeyMetadata extends Object implements Serializable




Serialized Fields


aWSAccountId
String aWSAccountId

 The twelve-digit account ID of the AWS account that owns the key.
 


keyId
String keyId

 The globally unique identifier for the key.
 


arn
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.
 


creationDate
Date creationDate

 The date and time when the key was created.
 


enabled
Boolean enabled

 Specifies whether the key is enabled. When KeyState is
 Enabled this value is true, otherwise it is false.
 


description
String description

 The friendly description of the key.
 


keyUsage
String keyUsage

 The cryptographic operations for which you can use the key. Currently the
 only allowed value is ENCRYPT_DECRYPT, which means you can
 use the key for the Encrypt and Decrypt operations.
 


keyState
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.
 


deletionDate
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.
 








Class com.amazonaws.services.kms.model.KeyUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.KMSInternalException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.KMSInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


limit
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.
 


marker
String marker

 Use this parameter only when paginating results and only in a subsequent
 request after you receive a response with truncated results. Set it to
 the value of NextMarker from the response you just received.
 








Class com.amazonaws.services.kms.model.ListAliasesResult extends Object implements Serializable




Serialized Fields


aliases
com.amazonaws.internal.SdkInternalList<T> aliases

 A list of key aliases in the user's account.
 


nextMarker
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.
 


truncated
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.
 








Class com.amazonaws.services.kms.model.ListGrantsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


limit
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.
 


marker
String marker

 Use this parameter only when paginating results and only in a subsequent
 request after you receive a response with truncated results. Set it to
 the value of NextMarker from the response you just received.
 


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 








Class com.amazonaws.services.kms.model.ListGrantsResult extends Object implements Serializable




Serialized Fields


grants
com.amazonaws.internal.SdkInternalList<T> grants

 A list of grants.
 


nextMarker
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.
 


truncated
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.
 








Class com.amazonaws.services.kms.model.ListKeyPoliciesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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/".
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Alias ARN Example -
 arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 Alias Name Example - alias/MyAliasName
 
 


limit
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.
 


marker
String marker

 Use this parameter only when paginating results and only in a subsequent
 request after you receive a response with truncated results. Set it to
 the value of NextMarker from the response you just received.
 








Class com.amazonaws.services.kms.model.ListKeyPoliciesResult extends Object implements Serializable




Serialized Fields


policyNames
com.amazonaws.internal.SdkInternalList<T> policyNames

 A list of policy names. Currently, there is only one policy and it is
 named "Default".
 


nextMarker
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.
 


truncated
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.
 








Class com.amazonaws.services.kms.model.ListKeysRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


limit
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.
 


marker
String marker

 Use this parameter only when paginating results and only in a subsequent
 request after you receive a response with truncated results. Set it to
 the value of NextMarker from the response you just received.
 








Class com.amazonaws.services.kms.model.ListKeysResult extends Object implements Serializable




Serialized Fields


keys
com.amazonaws.internal.SdkInternalList<T> keys

 A list of keys.
 


nextMarker
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.
 


truncated
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.
 








Class com.amazonaws.services.kms.model.ListRetirableGrantsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


limit
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.
 


marker
String marker

 Use this parameter only when paginating results and only in a subsequent
 request after you receive a response with truncated results. Set it to
 the value of NextMarker from the response you just received.
 


retiringPrincipal
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.
 








Class com.amazonaws.services.kms.model.ListRetirableGrantsResult extends Object implements Serializable




Serialized Fields


grants
com.amazonaws.internal.SdkInternalList<T> grants

 A list of grants.
 


nextMarker
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.
 


truncated
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.
 








Class com.amazonaws.services.kms.model.MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.PutKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 


policyName
String policyName

 Name of the policy to be attached. Currently, the only supported name is
 "default".
 


policy
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).
 








Class com.amazonaws.services.kms.model.ReEncryptRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 Ciphertext of the data to re-encrypt.
 


sourceEncryptionContext
com.amazonaws.internal.SdkInternalMap<K,V> sourceEncryptionContext

 Encryption context used to encrypt and decrypt the data specified in the
 CiphertextBlob parameter.
 


destinationKeyId
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/".
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Alias ARN Example -
 arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 Alias Name Example - alias/MyAliasName
 
 


destinationEncryptionContext
com.amazonaws.internal.SdkInternalMap<K,V> destinationEncryptionContext

 Encryption context to be used when the data is re-encrypted.
 


grantTokens
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.
 








Class com.amazonaws.services.kms.model.ReEncryptResult extends Object implements Serializable




Serialized Fields


ciphertextBlob
ByteBuffer ciphertextBlob

 The re-encrypted data. If you are using the CLI, the value is Base64
 encoded. Otherwise, it is not encoded.
 


sourceKeyId
String sourceKeyId

 Unique identifier of the key used to originally encrypt the data.
 


keyId
String keyId

 Unique identifier of the key used to re-encrypt the data.
 








Class com.amazonaws.services.kms.model.RetireGrantRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


grantToken
String grantToken

 Token that identifies the grant to be retired.
 


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 


grantId
String grantId

 Unique identifier of the grant to be retired. The grant ID is returned by
 the CreateGrant function.
 

 Grant ID Example -
 0123456789012345678901234567890123456789012345678901234567890123
 
 








Class com.amazonaws.services.kms.model.RevokeGrantRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 


grantId
String grantId

 Identifier of the grant to be revoked.
 








Class com.amazonaws.services.kms.model.ScheduleKeyDeletionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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:
 

 Unique key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
 Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-
 56ef-1234567890ab
 
 
 
 To obtain the unique key ID and key ARN for a given CMK, use
 ListKeys or DescribeKey.
 


pendingWindowInDays
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.
 








Class com.amazonaws.services.kms.model.ScheduleKeyDeletionResult extends Object implements Serializable




Serialized Fields


keyId
String keyId

 The unique identifier of the customer master key (CMK) for which deletion
 is scheduled.
 


deletionDate
Date deletionDate

 The date and time after which AWS KMS deletes the customer master key
 (CMK).
 








Class com.amazonaws.services.kms.model.UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.kms.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


aliasName
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.
 


targetKeyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 
 
 You can call ListAliases to verify that the alias is mapped to the
 correct TargetKeyId.
 








Class com.amazonaws.services.kms.model.UpdateKeyDescriptionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


keyId
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.
 

 Key ARN Example -
 arn:aws:kms:us-east-1:123456789012:key/12345678-1234
 -1234-1234-123456789012
 Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
 
 
 


description
String description

 New description for the key.
 








Package com.amazonaws.services.lambda.invoke




Class com.amazonaws.services.lambda.invoke.LambdaFunctionException extends RuntimeException implements Serializable

serialVersionUID:
1L





Serialized Fields


handled
boolean handled


type
String type








Class com.amazonaws.services.lambda.invoke.LambdaSerializationException extends RuntimeException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.lambda.model




Class com.amazonaws.services.lambda.model.AddPermissionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Name of the Lambda function whose resource policy you are updating by
 adding a new permission.  You can specify a 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 partial ARN (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-_]+))?



statementId
String statementId
A unique statement identifier.
 
 Constraints:

 Length: 1 - 100

 Pattern: ([a-zA-Z0-9-_]+)



action
String action
The AWS Lambda action you want to allow in this statement. Each Lambda
 action is a string starting with lambda: followed by the
 API name (see Operations). For example,
 lambda:CreateFunction. You can use wildcard
 (lambda:*) to grant permission for all AWS Lambda
 actions.
 
 Constraints:

 Pattern: (lambda:[*]|lambda:[a-zA-Z]+|[*])



principal
String principal
The principal who is getting this permission. It can be Amazon S3
 service Principal (s3.amazonaws.com) if you want Amazon
 S3 to invoke the function, an AWS account ID if you are granting
 cross-account permission, or any valid AWS service principal such as
 sns.amazonaws.com. For example, you might want to allow a
 custom application in another AWS account to push events to AWS Lambda
 by invoking your function.
 
 Constraints:

 Pattern: .*



sourceArn
String sourceArn
This is optional; however, when granting Amazon S3 permission to
 invoke your function, you should specify this field with the bucket
 Amazon Resource Name (ARN) as its value. This ensures that only events
 generated from the specified bucket can invoke the function.
 If you add a permission for the Amazon S3 principal without
 providing the source ARN, any AWS account that creates a mapping to
 your function ARN can send events to invoke your Lambda function from
 Amazon S3.
 
 Constraints:

 Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)



sourceAccount
String sourceAccount
The AWS account ID (without a hyphen) of the source owner. For
 example, if the 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}



eventSourceToken
String eventSourceToken


qualifier
String qualifier
You can use this optional query parameter to describe a qualified ARN
 using a function version or an alias name. The permission will then
 apply to the specific qualified ARN. For example, if you specify
 function version 2 as the qualifier, then permission applies only when
 request is made using qualified function ARN:
 arn:aws:lambda:aws-region:acct-id:function:function-name:2
 
If you specify an 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$_-]+)









Class com.amazonaws.services.lambda.model.AddPermissionResult extends Object implements Serializable




Serialized Fields


statement
String statement
The permission statement you specified in the request. The response
 returns the same as a string using a backslash ("\") as an escape
 character in the JSON.








Class com.amazonaws.services.lambda.model.AliasConfiguration extends Object implements Serializable




Serialized Fields


aliasArn
String aliasArn
Lambda function ARN that is qualified using the alias name as the
 suffix. For example, if you create an alias called BETA
 that points to a helloworld function version, the ARN is
 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-_]+))?



name
String name
Alias name.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)



functionVersion
String functionVersion
Function version to which the alias points.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



description
String description
Alias description.
 
 Constraints:

 Length: 0 - 256









Class com.amazonaws.services.lambda.model.CodeStorageExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.CreateAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Name of the Lambda function for which you want to create an alias.
 
 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-_]+))?



name
String name
Name for the alias you are creating.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)



functionVersion
String functionVersion
Lambda function version for which you are creating the alias.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



description
String description
Description of the alias.
 
 Constraints:

 Length: 0 - 256









Class com.amazonaws.services.lambda.model.CreateAliasResult extends Object implements Serializable




Serialized Fields


aliasArn
String aliasArn
Lambda function ARN that is qualified using the alias name as the
 suffix. For example, if you create an alias called BETA
 that points to a helloworld function version, the ARN is
 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-_]+))?



name
String name
Alias name.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)



functionVersion
String functionVersion
Function version to which the alias points.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



description
String description
Alias description.
 
 Constraints:

 Length: 0 - 256









Class com.amazonaws.services.lambda.model.CreateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


eventSourceArn
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon
 DynamoDB stream that is the event source. Any record added to this
 stream could cause AWS Lambda to invoke your Lambda function, it
 depends on the 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})?:(.*)



functionName
String functionName
The Lambda function to invoke when AWS Lambda detects an event on the
 stream.  You can specify the 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).
 
 If you are using versioning, you can also provide a qualified
 function ARN (ARN that is qualified with function version or alias
 name as suffix). For more information about versioning, see AWS
 Lambda Function Versioning and Aliases 
AWS Lambda also allows
 you to specify only the function name with 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-_]+))?



enabled
Boolean enabled
Indicates whether AWS Lambda should begin polling the event source. By
 default, Enabled is true.


batchSize
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your
 event source at the time of invoking your function. Your function
 receives an event with all the retrieved records. The default is 100
 records.
 
 Constraints:

 Range: 1 - 10000



startingPosition
String startingPosition
The position in the stream where AWS Lambda should start reading. For
 more information, go to ShardIteratorType
 in the Amazon Kinesis API Reference.
 
 Constraints:

 Allowed Values: TRIM_HORIZON, LATEST








Class com.amazonaws.services.lambda.model.CreateEventSourceMappingResult extends Object implements Serializable




Serialized Fields


uUID
String uUID
The AWS Lambda assigned opaque identifier for the mapping.


batchSize
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your
 event source at the time of invoking your function. Your function
 receives an event with all the retrieved records.
 
 Constraints:

 Range: 1 - 10000



eventSourceArn
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
 the source of events.
 
 Constraints:

 Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)



functionArn
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the
 stream.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



lastModified
Date lastModified
The UTC time string indicating the last time the event mapping was
 updated.


lastProcessingResult
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.


state
String state
The state of the event source mapping. It can be
 Creating, Enabled, Disabled,
 Enabling, Disabling, Updating,
 or Deleting.


stateTransitionReason
String stateTransitionReason
The reason the event source mapping is in its current state. It is
 either user-requested or an AWS Lambda-initiated state transition.








Class com.amazonaws.services.lambda.model.CreateFunctionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The name you want to assign to the function you are uploading. The
 function names appear in the console and are returned in the
 ListFunctions API. Function names are used to specify functions
 to other AWS Lambda APIs, such as Invoke.
 
 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-_]+))?



runtime
String runtime
The runtime environment for the Lambda function you are uploading.
 
 Constraints:

 Allowed Values: nodejs, nodejs4.3, java8, python2.7


role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes
 when it executes your function to access any other Amazon Web Services
 (AWS) resources. For more information, see AWS
 Lambda: How it Works.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function within your code that Lambda calls to begin execution.
 For Node.js, it is the module-name.export value in your
 function. For Java, it can be package.class-name::handler
 or package.class-name. For more information, see Lambda
 Function Handler (Java).
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



code
FunctionCode code
The code for the Lambda function.


description
String description
A short, user-defined function description. Lambda does not use this
 value. Assign a meaningful description as you see fit.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The amount of memory, in MB, your Lambda function is given. Lambda
 uses this memory size to infer the amount of CPU and memory allocated
 to your function. Your function use-case determines your CPU and
 memory requirements. For example, a database operation might need less
 memory compared to an image processing function. The default value is
 128 MB. The value must be a multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



publish
Boolean publish
This boolean parameter can be used to request AWS Lambda to create the
 Lambda function and publish a version as an atomic operation.


vpcConfig
VpcConfig vpcConfig
If your Lambda function accesses resources in a VPC, you provide this
 parameter identifying the list of security group IDs and subnet IDs.
 These must belong to the same VPC. You must provide at least one
 security group and one subnet ID.








Class com.amazonaws.services.lambda.model.CreateFunctionResult extends Object implements Serializable




Serialized Fields


functionName
String functionName
The name of the function.
 
 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-_]+))?



functionArn
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



runtime
String runtime
The runtime environment for the Lambda function.
 
 Constraints:

 Allowed Values: nodejs, nodejs4.3, java8, python2.7


role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes
 when it executes your function to access any other Amazon Web Services
 (AWS) resources.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function Lambda calls to begin executing your function.
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



codeSize
Long codeSize
The size, in bytes, of the function .zip file you uploaded.


description
String description
The user-provided description.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The memory size, in MB, you configured for the function. Must be a
 multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



lastModified
String lastModified
The time stamp of the last time you updated the function.


codeSha256
String codeSha256
It is the SHA256 hash of your function deployment package.


version
String version
The version of the Lambda function.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



vpcConfig
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.








Class com.amazonaws.services.lambda.model.DeleteAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The Lambda function name for which the alias is created. Deleting an
 alias does not delete the function version to which it is pointing.
 
 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-_]+))?



name
String name
Name of the alias to delete.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)









Class com.amazonaws.services.lambda.model.DeleteEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


uUID
String uUID
The event source mapping ID.








Class com.amazonaws.services.lambda.model.DeleteEventSourceMappingResult extends Object implements Serializable




Serialized Fields


uUID
String uUID
The AWS Lambda assigned opaque identifier for the mapping.


batchSize
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your
 event source at the time of invoking your function. Your function
 receives an event with all the retrieved records.
 
 Constraints:

 Range: 1 - 10000



eventSourceArn
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
 the source of events.
 
 Constraints:

 Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)



functionArn
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the
 stream.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



lastModified
Date lastModified
The UTC time string indicating the last time the event mapping was
 updated.


lastProcessingResult
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.


state
String state
The state of the event source mapping. It can be
 Creating, Enabled, Disabled,
 Enabling, Disabling, Updating,
 or Deleting.


stateTransitionReason
String stateTransitionReason
The reason the event source mapping is in its current state. It is
 either user-requested or an AWS Lambda-initiated state transition.








Class com.amazonaws.services.lambda.model.DeleteFunctionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The Lambda function to delete.  You can specify the 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).
 If you are using versioning, you can also provide a qualified function
 ARN (ARN that is qualified with function version or alias name as
 suffix). AWS Lambda also allows you to specify only the function name
 with 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-_]+))?



qualifier
String qualifier
Using this optional parameter you can specify a function version (but
 not the $LATEST version) to direct AWS Lambda to delete a
 specific function version. If the function version has one or more
 aliases pointing to it, you will get an error because you cannot have
 aliases pointing to it. You can delete any function version but not
 the $LATEST, that is, you cannot specify
 $LATEST as the value of this parameter. The
 $LATEST version can be deleted only when you want to
 delete all the function versions and aliases. You can only specify
 a function version, not an 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 of its versions and aliases.
 

 Constraints:

 Length: 1 - 128

 Pattern: (|[a-zA-Z0-9$_-]+)









Class com.amazonaws.services.lambda.model.EC2AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.EC2ThrottledException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.EC2UnexpectedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type


eC2ErrorCode
String eC2ErrorCode








Class com.amazonaws.services.lambda.model.ENILimitReachedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.EventSourceMappingConfiguration extends Object implements Serializable




Serialized Fields


uUID
String uUID
The AWS Lambda assigned opaque identifier for the mapping.


batchSize
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your
 event source at the time of invoking your function. Your function
 receives an event with all the retrieved records.
 
 Constraints:

 Range: 1 - 10000



eventSourceArn
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
 the source of events.
 
 Constraints:

 Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)



functionArn
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the
 stream.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



lastModified
Date lastModified
The UTC time string indicating the last time the event mapping was
 updated.


lastProcessingResult
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.


state
String state
The state of the event source mapping. It can be
 Creating, Enabled, Disabled,
 Enabling, Disabling, Updating,
 or Deleting.


stateTransitionReason
String stateTransitionReason
The reason the event source mapping is in its current state. It is
 either user-requested or an AWS Lambda-initiated state transition.








Class com.amazonaws.services.lambda.model.FunctionCode extends Object implements Serializable




Serialized Fields


zipFile
ByteBuffer zipFile
A zip file containing your deployment package. If you are using the
 API directly, the zip file must be base64-encoded (if you are using
 the AWS SDKs or the AWS CLI, the SDKs or CLI will do the encoding for
 you). For more information about creating a .zip file, go to Execution
 Permissions in the AWS Lambda Developer Guide.


s3Bucket
String s3Bucket
Amazon S3 bucket name where the .zip file containing your deployment
 package is stored. This bucket must reside in the same AWS region
 where you are creating the Lambda function.
 
 Constraints:

 Length: 3 - 63

 Pattern: ^[0-9A-Za-z\.\-_]*(?


s3Key
String s3Key
The Amazon S3 object (the deployment package) key name you want to
 upload.
 
 Constraints:

 Length: 1 - 1024



s3ObjectVersion
String s3ObjectVersion
The Amazon S3 object (the deployment package) version you want to
 upload.
 
 Constraints:

 Length: 1 - 1024









Class com.amazonaws.services.lambda.model.FunctionCodeLocation extends Object implements Serializable




Serialized Fields


repositoryType
String repositoryType
The repository from which you can download the function.


location
String location
The presigned URL you can use to download the function's .zip file
 that you previously uploaded. The URL is valid for up to 10 minutes.








Class com.amazonaws.services.lambda.model.FunctionConfiguration extends Object implements Serializable




Serialized Fields


functionName
String functionName
The name of the function.
 
 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-_]+))?



functionArn
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



runtime
String runtime
The runtime environment for the Lambda function.
 
 Constraints:

 Allowed Values: nodejs, nodejs4.3, java8, python2.7


role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes
 when it executes your function to access any other Amazon Web Services
 (AWS) resources.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function Lambda calls to begin executing your function.
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



codeSize
Long codeSize
The size, in bytes, of the function .zip file you uploaded.


description
String description
The user-provided description.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The memory size, in MB, you configured for the function. Must be a
 multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



lastModified
String lastModified
The time stamp of the last time you updated the function.


codeSha256
String codeSha256
It is the SHA256 hash of your function deployment package.


version
String version
The version of the Lambda function.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



vpcConfig
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.








Class com.amazonaws.services.lambda.model.GetAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Function name for which the alias is created. An alias is a
 subresource that exists only in the context of an existing Lambda
 function so you must specify the function name.
 
 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-_]+))?



name
String name
Name of the alias for which you want to retrieve information.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)









Class com.amazonaws.services.lambda.model.GetAliasResult extends Object implements Serializable




Serialized Fields


aliasArn
String aliasArn
Lambda function ARN that is qualified using the alias name as the
 suffix. For example, if you create an alias called BETA
 that points to a helloworld function version, the ARN is
 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-_]+))?



name
String name
Alias name.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)



functionVersion
String functionVersion
Function version to which the alias points.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



description
String description
Alias description.
 
 Constraints:

 Length: 0 - 256









Class com.amazonaws.services.lambda.model.GetEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


uUID
String uUID
The AWS Lambda assigned ID of the event source mapping.








Class com.amazonaws.services.lambda.model.GetEventSourceMappingResult extends Object implements Serializable




Serialized Fields


uUID
String uUID
The AWS Lambda assigned opaque identifier for the mapping.


batchSize
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your
 event source at the time of invoking your function. Your function
 receives an event with all the retrieved records.
 
 Constraints:

 Range: 1 - 10000



eventSourceArn
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
 the source of events.
 
 Constraints:

 Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)



functionArn
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the
 stream.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



lastModified
Date lastModified
The UTC time string indicating the last time the event mapping was
 updated.


lastProcessingResult
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.


state
String state
The state of the event source mapping. It can be
 Creating, Enabled, Disabled,
 Enabling, Disabling, Updating,
 or Deleting.


stateTransitionReason
String stateTransitionReason
The reason the event source mapping is in its current state. It is
 either user-requested or an AWS Lambda-initiated state transition.








Class com.amazonaws.services.lambda.model.GetFunctionConfigurationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The name of the Lambda function for which you want to retrieve the
 configuration information.  You can specify a 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 a partial ARN (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-_]+))?



qualifier
String qualifier
Using this optional parameter you can specify a function version or an
 alias name. If you specify function version, the API uses qualified
 function ARN and returns information about the specific function
 version. If you specify an alias name, the API uses the alias ARN and
 returns information about the function version to which the alias
 points. 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$_-]+)









Class com.amazonaws.services.lambda.model.GetFunctionConfigurationResult extends Object implements Serializable




Serialized Fields


functionName
String functionName
The name of the function.
 
 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-_]+))?



functionArn
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



runtime
String runtime
The runtime environment for the Lambda function.
 
 Constraints:

 Allowed Values: nodejs, nodejs4.3, java8, python2.7


role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes
 when it executes your function to access any other Amazon Web Services
 (AWS) resources.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function Lambda calls to begin executing your function.
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



codeSize
Long codeSize
The size, in bytes, of the function .zip file you uploaded.


description
String description
The user-provided description.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The memory size, in MB, you configured for the function. Must be a
 multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



lastModified
String lastModified
The time stamp of the last time you updated the function.


codeSha256
String codeSha256
It is the SHA256 hash of your function deployment package.


version
String version
The version of the Lambda function.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



vpcConfig
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.








Class com.amazonaws.services.lambda.model.GetFunctionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The Lambda function name.  You can specify a 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 a partial ARN (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-_]+))?



qualifier
String qualifier
Using this optional parameter to specify a function version or an
 alias name. If you specify function version, the API uses qualified
 function ARN for the request and returns information about the
 specific Lambda function version. If you specify an alias name, the
 API uses the alias ARN and returns information about the function
 version to which the alias points. If you don't provide this
 parameter, the API uses unqualified function ARN and returns
 information about the $LATEST version of the Lambda
 function.
 
 Constraints:

 Length: 1 - 128

 Pattern: (|[a-zA-Z0-9$_-]+)









Class com.amazonaws.services.lambda.model.GetFunctionResult extends Object implements Serializable




Serialized Fields


configuration
FunctionConfiguration configuration
A complex type that describes function metadata.


code
FunctionCodeLocation code
The object for the Lambda function location.








Class com.amazonaws.services.lambda.model.GetPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Function name whose resource policy you want to retrieve.  You can
 specify the 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).
 If you are using versioning, you can also provide a qualified function
 ARN (ARN that is qualified with function version or alias name as
 suffix). AWS Lambda also allows you to specify only the function name
 with 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-_]+))?



qualifier
String qualifier
You can specify this optional query parameter to specify a function
 version or an alias name in which case this API will return all
 permissions associated with the specific qualified ARN. If you don't
 provide this parameter, the API will return permissions that apply to
 the unqualified function ARN.
 
 Constraints:

 Length: 1 - 128

 Pattern: (|[a-zA-Z0-9$_-]+)









Class com.amazonaws.services.lambda.model.GetPolicyResult extends Object implements Serializable




Serialized Fields


policy
String policy
The resource policy associated with the specified function. The
 response returns the same as a string using a backslash ("\") as an
 escape character in the JSON.








Class com.amazonaws.services.lambda.model.InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvalidRequestContentException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvalidSecurityGroupIDException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvalidSubnetIDException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.InvokeAsyncRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Deprecated. 
The Lambda function name.
 
 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-_]+))?



invokeArgs
InputStream invokeArgs
Deprecated. 
JSON that you want to provide to your Lambda function as input.

 This stream must implement mark/reset in order for signature calculation to be performed
 before this data is read for the request payload.








Class com.amazonaws.services.lambda.model.InvokeAsyncResult extends Object implements Serializable




Serialized Fields


status
Integer status
Deprecated. 
It will be 202 upon success.








Class com.amazonaws.services.lambda.model.InvokeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The Lambda function name.  You can specify a 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 a partial ARN (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-_]+))?



invocationType
String invocationType
By default, the 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


logType
String logType
You can set this optional parameter to Tail in the
 request only if you specify the 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


clientContext
String clientContext
Using the 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, see PutEvents
 in the Amazon Mobile Analytics API Reference and User Guide.
 The ClientContext JSON must be base64-encoded.


payload
ByteBuffer payload
JSON that you want to provide to your Lambda function as input.


qualifier
String qualifier
You can use this optional parameter to specify a Lambda function
 version or alias name. If you specify a function version, the API uses
 the qualified function ARN to invoke a specific Lambda function. If
 you specify an alias name, the API uses the alias ARN to invoke the
 Lambda function version to which the alias points. 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$_-]+)









Class com.amazonaws.services.lambda.model.InvokeResult extends Object implements Serializable




Serialized Fields


statusCode
Integer statusCode
The HTTP status code will be in the 200 range for successful request.
 For the RequestResonse invocation type this status code
 will be 200. For the Event invocation type this status
 code will be 202. For the DryRun invocation type the
 status code will be 204.


functionError
String functionError
Indicates whether an error occurred while executing the Lambda
 function. If an error occurred this field will have one of two values;
 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.


logResult
String logResult
It is the base64-encoded logs for the Lambda function invocation. This
 is present only if the invocation type is RequestResponse
 and the logs were requested.


payload
ByteBuffer payload
It is the JSON representation of the object returned by the Lambda
 function. In This is present only if the invocation type is
 RequestResponse. 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.








Class com.amazonaws.services.lambda.model.ListAliasesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Lambda function name for which the alias is created.
 
 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-_]+))?



functionVersion
String functionVersion
If you specify this optional parameter, the API returns only the
 aliases that are pointing to the specific Lambda function version,
 otherwise the API returns all of the aliases created for the Lambda
 function.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



marker
String marker
Optional string. An opaque pagination token returned from a previous
 ListAliases operation. If present, indicates where to
 continue the listing.


maxItems
Integer maxItems
Optional integer. Specifies the maximum number of aliases to return in
 response. This parameter value must be greater than 0.
 
 Constraints:

 Range: 1 - 10000









Class com.amazonaws.services.lambda.model.ListAliasesResult extends Object implements Serializable




Serialized Fields


nextMarker
String nextMarker
A string, present if there are more aliases.


aliases
com.amazonaws.internal.ListWithAutoConstructFlag<T> aliases
A list of aliases.








Class com.amazonaws.services.lambda.model.ListEventSourceMappingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


eventSourceArn
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis stream.
 
 Constraints:

 Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)



functionName
String functionName
The name of the Lambda function.  You can specify the 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).
 If you are using versioning, you can also provide a qualified function
 ARN (ARN that is qualified with function version or alias name as
 suffix). AWS Lambda also allows you to specify only the function name
 with 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-_]+))?



marker
String marker
Optional string. An opaque pagination token returned from a previous
 ListEventSourceMappings operation. If present, specifies
 to continue the list from where the returning call left off.


maxItems
Integer maxItems
Optional integer. Specifies the maximum number of event sources to
 return in response. This value must be greater than 0.
 
 Constraints:

 Range: 1 - 10000









Class com.amazonaws.services.lambda.model.ListEventSourceMappingsResult extends Object implements Serializable




Serialized Fields


nextMarker
String nextMarker
A string, present if there are more event source mappings.


eventSourceMappings
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSourceMappings
An array of EventSourceMappingConfiguration objects.








Class com.amazonaws.services.lambda.model.ListFunctionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


marker
String marker
Optional string. An opaque pagination token returned from a previous
 ListFunctions operation. If present, indicates where to
 continue the listing.


maxItems
Integer maxItems
Optional integer. Specifies the maximum number of AWS Lambda functions
 to return in response. This parameter value must be greater than 0.
 
 Constraints:

 Range: 1 - 10000









Class com.amazonaws.services.lambda.model.ListFunctionsResult extends Object implements Serializable




Serialized Fields


nextMarker
String nextMarker
A string, present if there are more functions.


functions
com.amazonaws.internal.ListWithAutoConstructFlag<T> functions
A list of Lambda functions.








Class com.amazonaws.services.lambda.model.ListVersionsByFunctionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Function name whose versions to list. You can specify a 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 a partial ARN (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-_]+))?



marker
String marker
Optional string. An opaque pagination token returned from a previous
 ListVersionsByFunction operation. If present, indicates
 where to continue the listing.


maxItems
Integer maxItems
Optional integer. Specifies the maximum number of AWS Lambda function
 versions to return in response. This parameter value must be greater
 than 0.
 
 Constraints:

 Range: 1 - 10000









Class com.amazonaws.services.lambda.model.ListVersionsByFunctionResult extends Object implements Serializable




Serialized Fields


nextMarker
String nextMarker
A string, present if there are more function versions.


versions
com.amazonaws.internal.ListWithAutoConstructFlag<T> versions
A list of Lambda function versions.








Class com.amazonaws.services.lambda.model.PolicyLengthExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.PublishVersionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The Lambda function name. You can specify a 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 a partial ARN (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-_]+))?



codeSha256
String codeSha256
The SHA256 hash of the deployment package you want to publish. This
 provides validation on the code you are publishing. If you provide
 this parameter value must match the SHA256 of the $LATEST version for
 the publication to succeed.


description
String description
The description for the version you are publishing. If not provided,
 AWS Lambda copies the description from the $LATEST version.
 
 Constraints:

 Length: 0 - 256









Class com.amazonaws.services.lambda.model.PublishVersionResult extends Object implements Serializable




Serialized Fields


functionName
String functionName
The name of the function.
 
 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-_]+))?



functionArn
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



runtime
String runtime
The runtime environment for the Lambda function.
 
 Constraints:

 Allowed Values: nodejs, nodejs4.3, java8, python2.7


role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes
 when it executes your function to access any other Amazon Web Services
 (AWS) resources.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function Lambda calls to begin executing your function.
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



codeSize
Long codeSize
The size, in bytes, of the function .zip file you uploaded.


description
String description
The user-provided description.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The memory size, in MB, you configured for the function. Must be a
 multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



lastModified
String lastModified
The time stamp of the last time you updated the function.


codeSha256
String codeSha256
It is the SHA256 hash of your function deployment package.


version
String version
The version of the Lambda function.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



vpcConfig
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.








Class com.amazonaws.services.lambda.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
Lambda function whose resource policy you want to remove a permission
 from.  You can specify a 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 a partial ARN (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-_]+))?



statementId
String statementId
Statement ID of the permission to remove.
 
 Constraints:

 Length: 1 - 100

 Pattern: ([a-zA-Z0-9-_]+)



qualifier
String qualifier
You can specify this optional parameter to remove permission
 associated with a specific function version or function alias. If you
 don't specify this parameter, the API removes permission associated
 with the unqualified function ARN.
 
 Constraints:

 Length: 1 - 128

 Pattern: (|[a-zA-Z0-9$_-]+)









Class com.amazonaws.services.lambda.model.RequestTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.ResourceConflictException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.ServiceException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.SubnetIPAddressLimitReachedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


retryAfterSeconds
String retryAfterSeconds


type
String type








Class com.amazonaws.services.lambda.model.UnsupportedMediaTypeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


type
String type








Class com.amazonaws.services.lambda.model.UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The function name for which the alias is created.
 
 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-_]+))?



name
String name
The alias name.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)



functionVersion
String functionVersion
Using this parameter you can change the Lambda function version to
 which the alias points.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



description
String description
You can change the description of the alias using this parameter.
 
 Constraints:

 Length: 0 - 256









Class com.amazonaws.services.lambda.model.UpdateAliasResult extends Object implements Serializable




Serialized Fields


aliasArn
String aliasArn
Lambda function ARN that is qualified using the alias name as the
 suffix. For example, if you create an alias called BETA
 that points to a helloworld function version, the ARN is
 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-_]+))?



name
String name
Alias name.
 
 Constraints:

 Length: 1 - 128

 Pattern: (?!^[0-9]+$)([a-zA-Z0-9-_]+)



functionVersion
String functionVersion
Function version to which the alias points.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



description
String description
Alias description.
 
 Constraints:

 Length: 0 - 256









Class com.amazonaws.services.lambda.model.UpdateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


uUID
String uUID
The event source mapping identifier.


functionName
String functionName
The Lambda function to which you want the stream records sent.  You
 can specify a 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 a partial ARN (for example,
 account-id:Thumbnail). 
If you are using versioning,
 you can also provide a qualified function ARN (ARN that is qualified
 with function version or alias name as suffix). For more information
 about versioning, see AWS
 Lambda Function Versioning and Aliases 
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-_]+))?



enabled
Boolean enabled
Specifies whether AWS Lambda should actively poll the stream or not.
 If disabled, AWS Lambda will not poll the stream.


batchSize
Integer batchSize
The maximum number of stream records that can be sent to your Lambda
 function for a single invocation.
 
 Constraints:

 Range: 1 - 10000









Class com.amazonaws.services.lambda.model.UpdateEventSourceMappingResult extends Object implements Serializable




Serialized Fields


uUID
String uUID
The AWS Lambda assigned opaque identifier for the mapping.


batchSize
Integer batchSize
The largest number of records that AWS Lambda will retrieve from your
 event source at the time of invoking your function. Your function
 receives an event with all the retrieved records.
 
 Constraints:

 Range: 1 - 10000



eventSourceArn
String eventSourceArn
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is
 the source of events.
 
 Constraints:

 Pattern: arn:aws:([a-zA-Z0-9\-])+:([a-z]{2}-[a-z]+-\d{1})?:(\d{12})?:(.*)



functionArn
String functionArn
The Lambda function to invoke when AWS Lambda detects an event on the
 stream.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



lastModified
Date lastModified
The UTC time string indicating the last time the event mapping was
 updated.


lastProcessingResult
String lastProcessingResult
The result of the last AWS Lambda invocation of your Lambda function.


state
String state
The state of the event source mapping. It can be
 Creating, Enabled, Disabled,
 Enabling, Disabling, Updating,
 or Deleting.


stateTransitionReason
String stateTransitionReason
The reason the event source mapping is in its current state. It is
 either user-requested or an AWS Lambda-initiated state transition.








Class com.amazonaws.services.lambda.model.UpdateFunctionCodeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The existing Lambda function name whose code you want to replace. 
 You can specify a 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 a partial ARN (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-_]+))?



zipFile
ByteBuffer zipFile
Based64-encoded .zip file containing your packaged source code.


s3Bucket
String s3Bucket
Amazon S3 bucket name where the .zip file containing your deployment
 package is stored. This bucket must reside in the same AWS region
 where you are creating the Lambda function.
 
 Constraints:

 Length: 3 - 63

 Pattern: ^[0-9A-Za-z\.\-_]*(?


s3Key
String s3Key
The Amazon S3 object (the deployment package) key name you want to
 upload.
 
 Constraints:

 Length: 1 - 1024



s3ObjectVersion
String s3ObjectVersion
The Amazon S3 object (the deployment package) version you want to
 upload.
 
 Constraints:

 Length: 1 - 1024



publish
Boolean publish
This boolean parameter can be used to request AWS Lambda to update the
 Lambda function and publish a version as an atomic operation.








Class com.amazonaws.services.lambda.model.UpdateFunctionCodeResult extends Object implements Serializable




Serialized Fields


functionName
String functionName
The name of the function.
 
 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-_]+))?



functionArn
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



runtime
String runtime
The runtime environment for the Lambda function.
 
 Constraints:

 Allowed Values: nodejs, nodejs4.3, java8, python2.7


role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes
 when it executes your function to access any other Amazon Web Services
 (AWS) resources.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function Lambda calls to begin executing your function.
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



codeSize
Long codeSize
The size, in bytes, of the function .zip file you uploaded.


description
String description
The user-provided description.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The memory size, in MB, you configured for the function. Must be a
 multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



lastModified
String lastModified
The time stamp of the last time you updated the function.


codeSha256
String codeSha256
It is the SHA256 hash of your function deployment package.


version
String version
The version of the Lambda function.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



vpcConfig
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.








Class com.amazonaws.services.lambda.model.UpdateFunctionConfigurationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


functionName
String functionName
The name of the Lambda function.  You can specify a 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 a partial ARN (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-_]+))?



role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda will assume
 when it executes your function.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function that Lambda calls to begin executing your function. For
 Node.js, it is the module-name.export value in your
 function.
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



description
String description
A short user-defined function description. AWS Lambda does not use
 this value. Assign a meaningful description as you see fit.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which AWS Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The amount of memory, in MB, your Lambda function is given. AWS Lambda
 uses this memory size to infer the amount of CPU allocated to your
 function. Your function use-case determines your CPU and memory
 requirements. For example, a database operation might need less memory
 compared to an image processing function. The default value is 128 MB.
 The value must be a multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



vpcConfig
VpcConfig vpcConfig
If your Lambda function accesses resources in a VPC, you provide this
 parameter identifying the list of security group IDs and subnet IDs.
 These must belong to the same VPC. You must provide at least one
 security group and one subnet ID.


runtime
String runtime








Class com.amazonaws.services.lambda.model.UpdateFunctionConfigurationResult extends Object implements Serializable




Serialized Fields


functionName
String functionName
The name of the function.
 
 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-_]+))?



functionArn
String functionArn
The Amazon Resource Name (ARN) assigned to the function.
 
 Constraints:

 Pattern: arn:aws:lambda:[a-z]{2}-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?



runtime
String runtime
The runtime environment for the Lambda function.
 
 Constraints:

 Allowed Values: nodejs, nodejs4.3, java8, python2.7


role
String role
The Amazon Resource Name (ARN) of the IAM role that Lambda assumes
 when it executes your function to access any other Amazon Web Services
 (AWS) resources.
 
 Constraints:

 Pattern: arn:aws:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+



handler
String handler
The function Lambda calls to begin executing your function.
 
 Constraints:

 Length: 0 - 128

 Pattern: [^\s]+



codeSize
Long codeSize
The size, in bytes, of the function .zip file you uploaded.


description
String description
The user-provided description.
 
 Constraints:

 Length: 0 - 256



timeout
Integer timeout
The function execution time at which Lambda should terminate the
 function. Because the execution time has cost implications, we
 recommend you set this value based on your expected execution time.
 The default is 3 seconds.
 
 Constraints:

 Range: 1 - 



memorySize
Integer memorySize
The memory size, in MB, you configured for the function. Must be a
 multiple of 64 MB.
 
 Constraints:

 Range: 128 - 1536



lastModified
String lastModified
The time stamp of the last time you updated the function.


codeSha256
String codeSha256
It is the SHA256 hash of your function deployment package.


version
String version
The version of the Lambda function.
 
 Constraints:

 Length: 1 - 1024

 Pattern: (\$LATEST|[0-9]+)



vpcConfig
VpcConfigResponse vpcConfig
VPC configuration associated with your Lambda function.








Class com.amazonaws.services.lambda.model.VpcConfig extends Object implements Serializable




Serialized Fields


subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
A list of one or more subnet IDs in your VPC.
 
 Constraints:

 Length: 0 - 16



securityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
A list of one or more security groups IDs in your VPC.
 
 Constraints:

 Length: 0 - 5









Class com.amazonaws.services.lambda.model.VpcConfigResponse extends Object implements Serializable




Serialized Fields


subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
A list of subnet IDs associated with the Lambda function.
 
 Constraints:

 Length: 0 - 16



securityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> securityGroupIds
A list of security group IDs associated with the Lambda function.
 
 Constraints:

 Length: 0 - 5



vpcId
String vpcId
The VPC ID associated with you Lambda function.








Package com.amazonaws.services.logs.model




Class com.amazonaws.services.logs.model.CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


taskId
String taskId

 Id of the export task to cancel.
 








Class com.amazonaws.services.logs.model.CreateExportTaskRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


taskName
String taskName

 The name of the export task.
 


logGroupName
String logGroupName

 The name of the log group to export.
 


logStreamNamePrefix
String logStreamNamePrefix

 Will only export log streams that match the provided logStreamNamePrefix.
 If you don't specify a value, no prefix filter is applied.
 


from
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.
 


to
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.
 


destination
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.
 


destinationPrefix
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'.
 








Class com.amazonaws.services.logs.model.CreateExportTaskResult extends Object implements Serializable




Serialized Fields


taskId
String taskId

 Id of the export task that got created.
 








Class com.amazonaws.services.logs.model.CreateLogGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to create.
 








Class com.amazonaws.services.logs.model.CreateLogStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group under which the log stream is to be created.
 


logStreamName
String logStreamName

 The name of the log stream to create.
 








Class com.amazonaws.services.logs.model.DataAlreadyAcceptedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


expectedSequenceToken
String expectedSequenceToken








Class com.amazonaws.services.logs.model.DeleteDestinationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


destinationName
String destinationName

 The name of destination to delete.
 








Class com.amazonaws.services.logs.model.DeleteLogGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to delete.
 








Class com.amazonaws.services.logs.model.DeleteLogStreamRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group under which the log stream to delete belongs.
 


logStreamName
String logStreamName

 The name of the log stream to delete.
 








Class com.amazonaws.services.logs.model.DeleteMetricFilterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group that is associated with the metric filter to
 delete.
 


filterName
String filterName

 The name of the metric filter to delete.
 








Class com.amazonaws.services.logs.model.DeleteRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group that is associated with the retention policy to
 delete.
 








Class com.amazonaws.services.logs.model.DeleteSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group that is associated with the subscription filter
 to delete.
 


filterName
String filterName

 The name of the subscription filter to delete.
 








Class com.amazonaws.services.logs.model.DescribeDestinationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


destinationNamePrefix
String destinationNamePrefix

 Will only return destinations that match the provided
 destinationNamePrefix. If you don't specify a value, no prefix is
 applied.
 


nextToken
String nextToken


limit
Integer limit








Class com.amazonaws.services.logs.model.DescribeDestinationsResult extends Object implements Serializable




Serialized Fields


destinations
com.amazonaws.internal.SdkInternalList<T> destinations


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


taskId
String taskId

 Export task that matches the specified task Id will be returned. This can
 result in zero or one export task.
 


statusCode
String statusCode

 All export tasks that matches the specified status code will be returned.
 This can return zero or more export tasks.
 


nextToken
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.
 


limit
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.
 








Class com.amazonaws.services.logs.model.DescribeExportTasksResult extends Object implements Serializable




Serialized Fields


exportTasks
com.amazonaws.internal.SdkInternalList<T> exportTasks


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeLogGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupNamePrefix
String logGroupNamePrefix

 Will only return log groups that match the provided logGroupNamePrefix.
 If you don't specify a value, no prefix filter is applied.
 


nextToken
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.
 


limit
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.
 








Class com.amazonaws.services.logs.model.DescribeLogGroupsResult extends Object implements Serializable




Serialized Fields


logGroups
com.amazonaws.internal.SdkInternalList<T> logGroups


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeLogStreamsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The log group name for which log streams are to be listed.
 


logStreamNamePrefix
String logStreamNamePrefix

 Will only return log streams that match the provided logStreamNamePrefix.
 If you don't specify a value, no prefix filter is applied.
 


orderBy
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.
 


descending
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.
 


nextToken
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.
 


limit
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.
 








Class com.amazonaws.services.logs.model.DescribeLogStreamsResult extends Object implements Serializable




Serialized Fields


logStreams
com.amazonaws.internal.SdkInternalList<T> logStreams


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeMetricFiltersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The log group name for which metric filters are to be listed.
 


filterNamePrefix
String filterNamePrefix

 Will only return metric filters that match the provided filterNamePrefix.
 If you don't specify a value, no prefix filter is applied.
 


nextToken
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.
 


limit
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.
 








Class com.amazonaws.services.logs.model.DescribeMetricFiltersResult extends Object implements Serializable




Serialized Fields


metricFilters
com.amazonaws.internal.SdkInternalList<T> metricFilters


nextToken
String nextToken








Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The log group name for which subscription filters are to be listed.
 


filterNamePrefix
String filterNamePrefix

 Will only return subscription filters that match the provided
 filterNamePrefix. If you don't specify a value, no prefix filter is
 applied.
 


nextToken
String nextToken


limit
Integer limit








Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersResult extends Object implements Serializable




Serialized Fields


subscriptionFilters
com.amazonaws.internal.SdkInternalList<T> subscriptionFilters


nextToken
String nextToken








Class com.amazonaws.services.logs.model.Destination extends Object implements Serializable




Serialized Fields


destinationName
String destinationName

 Name of the destination.
 


targetArn
String targetArn

 ARN of the physical target where the log events will be delivered (eg.
 ARN of a Kinesis stream).
 


roleArn
String roleArn

 A role for impersonation for delivering log events to the target.
 


accessPolicy
String accessPolicy

 An IAM policy document that governs which AWS accounts can create
 subscription filters against this destination.
 


arn
String arn

 ARN of this destination.
 


creationTime
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.
 








Class com.amazonaws.services.logs.model.ExportTask extends Object implements Serializable




Serialized Fields


taskId
String taskId

 Id of the export task.
 


taskName
String taskName

 The name of the export task.
 


logGroupName
String logGroupName

 The name of the log group from which logs data was exported.
 


from
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.
 


to
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.
 


destination
String destination

 Name of Amazon S3 bucket to which the log data was exported.
 


destinationPrefix
String destinationPrefix

 Prefix that was used as the start of Amazon S3 key for every object
 exported.
 


status
ExportTaskStatus status

 Status of the export task.
 


executionInfo
ExportTaskExecutionInfo executionInfo

 Execution info about the export task.
 








Class com.amazonaws.services.logs.model.ExportTaskExecutionInfo extends Object implements Serializable




Serialized Fields


creationTime
Long creationTime

 A point in time when the export task got created.
 


completionTime
Long completionTime

 A point in time when the export task got completed.
 








Class com.amazonaws.services.logs.model.ExportTaskStatus extends Object implements Serializable




Serialized Fields


code
String code

 Status code of the export task.
 


message
String message

 Status message related to the code.
 








Class com.amazonaws.services.logs.model.FilteredLogEvent extends Object implements Serializable




Serialized Fields


logStreamName
String logStreamName

 The name of the log stream this event belongs to.
 


timestamp
Long timestamp


message
String message

 The data contained in the log event.
 


ingestionTime
Long ingestionTime


eventId
String eventId

 A unique identifier for this event.
 








Class com.amazonaws.services.logs.model.FilterLogEventsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to query.
 


logStreamNames
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.
 


startTime
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.
 


endTime
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.
 


filterPattern
String filterPattern

 A valid CloudWatch Logs filter pattern to use for filtering the response.
 If not provided, all the events are matched.
 


nextToken
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.
 


limit
Integer limit

 The maximum number of events to return in a page of results. Default is
 10,000 events.
 


interleaved
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.
 








Class com.amazonaws.services.logs.model.FilterLogEventsResult extends Object implements Serializable




Serialized Fields


events
com.amazonaws.internal.SdkInternalList<T> events

 A list of FilteredLogEvent objects representing
 the matched events from the request.
 


searchedLogStreams
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.
 


nextToken
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.
 








Class com.amazonaws.services.logs.model.GetLogEventsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to query.
 


logStreamName
String logStreamName

 The name of the log stream to query.
 


startTime
Long startTime


endTime
Long endTime


nextToken
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.
 


limit
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.
 


startFromHead
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).
 








Class com.amazonaws.services.logs.model.GetLogEventsResult extends Object implements Serializable




Serialized Fields


events
com.amazonaws.internal.SdkInternalList<T> events


nextForwardToken
String nextForwardToken


nextBackwardToken
String nextBackwardToken








Class com.amazonaws.services.logs.model.InputLogEvent extends Object implements Serializable




Serialized Fields


timestamp
Long timestamp


message
String message








Class com.amazonaws.services.logs.model.InvalidOperationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.InvalidSequenceTokenException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


expectedSequenceToken
String expectedSequenceToken








Class com.amazonaws.services.logs.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.LogGroup extends Object implements Serializable




Serialized Fields


logGroupName
String logGroupName


creationTime
Long creationTime


retentionInDays
Integer retentionInDays


metricFilterCount
Integer metricFilterCount


arn
String arn


storedBytes
Long storedBytes








Class com.amazonaws.services.logs.model.LogStream extends Object implements Serializable




Serialized Fields


logStreamName
String logStreamName


creationTime
Long creationTime


firstEventTimestamp
Long firstEventTimestamp


lastEventTimestamp
Long lastEventTimestamp


lastIngestionTime
Long lastIngestionTime


uploadSequenceToken
String uploadSequenceToken


arn
String arn


storedBytes
Long storedBytes








Class com.amazonaws.services.logs.model.MetricFilter extends Object implements Serializable




Serialized Fields


filterName
String filterName


filterPattern
String filterPattern


metricTransformations
com.amazonaws.internal.SdkInternalList<T> metricTransformations


creationTime
Long creationTime








Class com.amazonaws.services.logs.model.MetricFilterMatchRecord extends Object implements Serializable




Serialized Fields


eventNumber
Long eventNumber


eventMessage
String eventMessage


extractedValues
com.amazonaws.internal.SdkInternalMap<K,V> extractedValues








Class com.amazonaws.services.logs.model.MetricTransformation extends Object implements Serializable




Serialized Fields


metricName
String metricName


metricNamespace
String metricNamespace


metricValue
String metricValue








Class com.amazonaws.services.logs.model.OperationAbortedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.OutputLogEvent extends Object implements Serializable




Serialized Fields


timestamp
Long timestamp


message
String message


ingestionTime
Long ingestionTime








Class com.amazonaws.services.logs.model.PutDestinationPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


destinationName
String destinationName

 A name for an existing destination.
 


accessPolicy
String accessPolicy

 An IAM policy document that authorizes cross-account users to deliver
 their log events to associated destination.
 








Class com.amazonaws.services.logs.model.PutDestinationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


destinationName
String destinationName

 A name for the destination.
 


targetArn
String targetArn

 The ARN of an Amazon Kinesis stream to deliver matching log events to.
 


roleArn
String roleArn

 The ARN of an IAM role that grants CloudWatch Logs permissions to do
 Amazon Kinesis PutRecord requests on the desitnation stream.
 








Class com.amazonaws.services.logs.model.PutDestinationResult extends Object implements Serializable




Serialized Fields


destination
Destination destination








Class com.amazonaws.services.logs.model.PutLogEventsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to put log events to.
 


logStreamName
String logStreamName

 The name of the log stream to put log events to.
 


logEvents
com.amazonaws.internal.SdkInternalList<T> logEvents


sequenceToken
String sequenceToken

 A string token that must be obtained from the response of the previous
 PutLogEvents request.
 








Class com.amazonaws.services.logs.model.PutLogEventsResult extends Object implements Serializable




Serialized Fields


nextSequenceToken
String nextSequenceToken


rejectedLogEventsInfo
RejectedLogEventsInfo rejectedLogEventsInfo








Class com.amazonaws.services.logs.model.PutMetricFilterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to associate the metric filter with.
 


filterName
String filterName

 A name for the metric filter.
 


filterPattern
String filterPattern

 A valid CloudWatch Logs filter pattern for extracting metric data out of
 ingested log events.
 


metricTransformations
com.amazonaws.internal.SdkInternalList<T> metricTransformations

 A collection of information needed to define how metric data gets
 emitted.
 








Class com.amazonaws.services.logs.model.PutRetentionPolicyRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to associate the retention policy with.
 


retentionInDays
Integer retentionInDays








Class com.amazonaws.services.logs.model.PutSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


logGroupName
String logGroupName

 The name of the log group to associate the subscription filter with.
 


filterName
String filterName

 A name for the subscription filter.
 


filterPattern
String filterPattern

 A valid CloudWatch Logs filter pattern for subscribing to a filtered
 stream of log events.
 


destinationArn
String destinationArn

 The ARN of the destination to deliver matching log events to. Currently,
 the supported destinations are:
 

 An Amazon Kinesis stream belonging to the same account as the
 subscription filter, for same-account delivery.
 A logical destination (used via an ARN of Destination)
 belonging to a different account, for cross-account delivery.
 An Amazon Kinesis Firehose stream belonging to the same account as
 the subscription filter, for same-account delivery.
 An AWS Lambda function belonging to the same account as the
 subscription filter, for same-account delivery.
 
 


roleArn
String roleArn

 The ARN of an IAM role that grants 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.
 








Class com.amazonaws.services.logs.model.RejectedLogEventsInfo extends Object implements Serializable




Serialized Fields


tooNewLogEventStartIndex
Integer tooNewLogEventStartIndex


tooOldLogEventEndIndex
Integer tooOldLogEventEndIndex


expiredLogEventEndIndex
Integer expiredLogEventEndIndex








Class com.amazonaws.services.logs.model.ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.SearchedLogStream extends Object implements Serializable




Serialized Fields


logStreamName
String logStreamName

 The name of the log stream.
 


searchedCompletely
Boolean searchedCompletely

 Indicates whether all the events in this log stream were searched or more
 data exists to search by paginating further.
 








Class com.amazonaws.services.logs.model.ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.logs.model.SubscriptionFilter extends Object implements Serializable




Serialized Fields


filterName
String filterName


logGroupName
String logGroupName


filterPattern
String filterPattern


destinationArn
String destinationArn


roleArn
String roleArn


creationTime
Long creationTime








Class com.amazonaws.services.logs.model.TestMetricFilterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


filterPattern
String filterPattern


logEventMessages
com.amazonaws.internal.SdkInternalList<T> logEventMessages

 A list of log event messages to test.
 








Class com.amazonaws.services.logs.model.TestMetricFilterResult extends Object implements Serializable




Serialized Fields


matches
com.amazonaws.internal.SdkInternalList<T> matches








Package com.amazonaws.services.machinelearning.model




Class com.amazonaws.services.machinelearning.model.BatchPrediction extends Object implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 The ID assigned to the BatchPrediction at creation. This
 value should be identical to the value of the
 BatchPredictionID in the request.
 


mLModelId
String mLModelId

 The ID of the MLModel that generated predictions for the
 BatchPrediction request.
 


batchPredictionDataSourceId
String batchPredictionDataSourceId

 The ID of the DataSource that points to the group of
 observations to predict.
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage
 Service (Amazon S3).
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time that the BatchPrediction was created. The time is
 expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the BatchPrediction. The
 time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the BatchPrediction.
 


status
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.
 


outputUri
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: ':', '//', '/./', '/../'.
 


message
String message

 A description of the most recent details about processing the batch
 prediction request.
 








Class com.amazonaws.services.machinelearning.model.CreateBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 A user-supplied ID that uniquely identifies the
 BatchPrediction.
 


batchPredictionName
String batchPredictionName

 A user-supplied name or description of the BatchPrediction.
 BatchPredictionName can only use the UTF-8 character set.
 


mLModelId
String mLModelId

 The ID of the MLModel that will generate predictions for the
 group of observations.
 


batchPredictionDataSourceId
String batchPredictionDataSourceId

 The ID of the DataSource that points to the group of
 observations to predict.
 


outputUri
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.
 








Class com.amazonaws.services.machinelearning.model.CreateBatchPredictionResult extends Object implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 A user-supplied ID that uniquely identifies the
 BatchPrediction. This value is identical to the value of the
 BatchPredictionId in the request.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRDSRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource.
 Typically, an Amazon Resource Number (ARN) becomes the ID for a
 DataSource.
 


dataSourceName
String dataSourceName

 A user-supplied name or description of the DataSource.
 


rDSData
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}}"
 
 
 


roleARN
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.
 
 
 


computeStatistics
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.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRDSResult extends Object implements Serializable




Serialized Fields


dataSourceId
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.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRedshiftRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource.
 


dataSourceName
String dataSourceName

 A user-supplied name or description of the DataSource.
 


dataSpec
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}}"
 
 
 


roleARN
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
 
 
 
 


computeStatistics
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
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRedshiftResult extends Object implements Serializable




Serialized Fields


dataSourceId
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.
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromS3Request extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied identifier that uniquely identifies the
 DataSource.
 


dataSourceName
String dataSourceName

 A user-supplied name or description of the DataSource.
 


dataSpec
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}}"
 
 
 


computeStatistics
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
 








Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromS3Result extends Object implements Serializable




Serialized Fields


dataSourceId
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.
 








Class com.amazonaws.services.machinelearning.model.CreateEvaluationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


evaluationId
String evaluationId

 A user-supplied ID that uniquely identifies the Evaluation.
 


evaluationName
String evaluationName

 A user-supplied name or description of the Evaluation.
 


mLModelId
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
 .
 


evaluationDataSourceId
String evaluationDataSourceId

 The ID of the DataSource for the evaluation. The schema of
 the DataSource must match the schema used to create the
 MLModel.
 








Class com.amazonaws.services.machinelearning.model.CreateEvaluationResult extends Object implements Serializable




Serialized Fields


evaluationId
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.
 








Class com.amazonaws.services.machinelearning.model.CreateMLModelRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mLModelId
String mLModelId

 A user-supplied ID that uniquely identifies the MLModel.
 


mLModelName
String mLModelName

 A user-supplied name or description of the MLModel.
 


mLModelType
String mLModelType

 The category of supervised learning that this MLModel will
 address. Choose from the following types:
 
 
 Choose REGRESSION if the MLModel will be
 used to predict a numeric value.
 Choose BINARY if the MLModel result has two
 possible values.
 Choose MULTICLASS if the MLModel result has
 a limited number of values.
 
 
 For more information, see the Amazon
 Machine Learning Developer Guide.
 


parameters
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.
 
 
 


trainingDataSourceId
String trainingDataSourceId

 The DataSource that points to the training data.
 


recipe
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.
 


recipeUri
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.
 








Class com.amazonaws.services.machinelearning.model.CreateMLModelResult extends Object implements Serializable




Serialized Fields


mLModelId
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.
 








Class com.amazonaws.services.machinelearning.model.CreateRealtimeEndpointRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel during creation.
 








Class com.amazonaws.services.machinelearning.model.CreateRealtimeEndpointResult extends Object implements Serializable




Serialized Fields


mLModelId
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 realtimeEndpointInfo

 The endpoint information of the MLModel
 








Class com.amazonaws.services.machinelearning.model.DataSource extends Object implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 The ID that is assigned to the DataSource during creation.
 


dataLocationS3
String dataLocationS3

 The location and name of the data in Amazon Simple Storage Service
 (Amazon S3) that is used by a DataSource.
 


dataRearrangement
String dataRearrangement

 A JSON string that represents the splitting requirement of a
 Datasource.
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time that the DataSource was created. The time is
 expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the BatchPrediction. The
 time is expressed in epoch time.
 


dataSizeInBytes
Long dataSizeInBytes

 The total number of observations contained in the data files that the
 DataSource references.
 


numberOfFiles
Long numberOfFiles

 The number of data files referenced by the DataSource.
 


name
String name

 A user-supplied name or description of the DataSource.
 


status
String status

 The current status of the DataSource. This element can have
 one of the following values:
 
 
 PENDING - Amazon Machine Learning (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.
 


message
String message

 A description of the most recent details about creating the
 DataSource.
 


redshiftMetadata
RedshiftMetadata redshiftMetadata


rDSMetadata
RDSMetadata rDSMetadata


roleARN
String roleARN


computeStatistics
Boolean computeStatistics

 The parameter is true if statistics need to be generated
 from the observation data.
 








Class com.amazonaws.services.machinelearning.model.DeleteBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 A user-supplied ID that uniquely identifies the
 BatchPrediction.
 








Class com.amazonaws.services.machinelearning.model.DeleteBatchPredictionResult extends Object implements Serializable




Serialized Fields


batchPredictionId
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.
 








Class com.amazonaws.services.machinelearning.model.DeleteDataSourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 A user-supplied ID that uniquely identifies the DataSource.
 








Class com.amazonaws.services.machinelearning.model.DeleteDataSourceResult extends Object implements Serializable




Serialized Fields


dataSourceId
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.
 








Class com.amazonaws.services.machinelearning.model.DeleteEvaluationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


evaluationId
String evaluationId

 A user-supplied ID that uniquely identifies the Evaluation
 to delete.
 








Class com.amazonaws.services.machinelearning.model.DeleteEvaluationResult extends Object implements Serializable




Serialized Fields


evaluationId
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.
 








Class com.amazonaws.services.machinelearning.model.DeleteMLModelRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mLModelId
String mLModelId

 A user-supplied ID that uniquely identifies the MLModel.
 








Class com.amazonaws.services.machinelearning.model.DeleteMLModelResult extends Object implements Serializable




Serialized Fields


mLModelId
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.
 








Class com.amazonaws.services.machinelearning.model.DeleteRealtimeEndpointRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel during creation.
 








Class com.amazonaws.services.machinelearning.model.DeleteRealtimeEndpointResult extends Object implements Serializable




Serialized Fields


mLModelId
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 realtimeEndpointInfo

 The endpoint information of the MLModel
 








Class com.amazonaws.services.machinelearning.model.DescribeBatchPredictionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


filterVariable
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.
 


eQ
String eQ

 The equal to operator. The BatchPrediction results will have
 FilterVariable values that exactly match the value specified
 with EQ.
 


gT
String gT

 The greater than operator. The BatchPrediction results will
 have FilterVariable values that are greater than the value
 specified with GT.
 


lT
String lT

 The less than operator. The BatchPrediction results will
 have FilterVariable values that are less than the value
 specified with LT.
 


gE
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.
 


lE
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.
 


nE
String nE

 The not equal to operator. The BatchPrediction results will
 have FilterVariable values not equal to the value specified
 with NE.
 


prefix
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
 
 
 


sortOrder
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.
 


nextToken
String nextToken

 An ID of the page in the paginated results.
 


limit
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.
 








Class com.amazonaws.services.machinelearning.model.DescribeBatchPredictionsResult extends Object implements Serializable




Serialized Fields


results
com.amazonaws.internal.SdkInternalList<T> results

 A list of BatchPrediction objects that meet the search criteria.
 


nextToken
String nextToken

 The ID of the next page in the paginated results that indicates at least
 one more page follows.
 








Class com.amazonaws.services.machinelearning.model.DescribeDataSourcesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


filterVariable
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.
 


eQ
String eQ

 The equal to operator. The DataSource results will have
 FilterVariable values that exactly match the value specified
 with EQ.
 


gT
String gT

 The greater than operator. The DataSource results will have
 FilterVariable values that are greater than the value
 specified with GT.
 


lT
String lT

 The less than operator. The DataSource results will have
 FilterVariable values that are less than the value specified
 with LT.
 


gE
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.
 


lE
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.
 


nE
String nE

 The not equal to operator. The DataSource results will have
 FilterVariable values not equal to the value specified with
 NE.
 


prefix
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
 
 
 


sortOrder
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.
 


nextToken
String nextToken

 The ID of the page in the paginated results.
 


limit
Integer limit

 The maximum number of DataSource to include in the result.
 








Class com.amazonaws.services.machinelearning.model.DescribeDataSourcesResult extends Object implements Serializable




Serialized Fields


results
com.amazonaws.internal.SdkInternalList<T> results

 A list of DataSource that meet the search criteria.
 


nextToken
String nextToken

 An ID of the next page in the paginated results that indicates at least
 one more page follows.
 








Class com.amazonaws.services.machinelearning.model.DescribeEvaluationsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


filterVariable
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.
 


eQ
String eQ

 The equal to operator. The Evaluation results will have
 FilterVariable values that exactly match the value specified
 with EQ.
 


gT
String gT

 The greater than operator. The Evaluation results will have
 FilterVariable values that are greater than the value
 specified with GT.
 


lT
String lT

 The less than operator. The Evaluation results will have
 FilterVariable values that are less than the value specified
 with LT.
 


gE
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.
 


lE
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.
 


nE
String nE

 The not equal to operator. The Evaluation results will have
 FilterVariable values not equal to the value specified with
 NE.
 


prefix
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
 
 
 


sortOrder
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.
 


nextToken
String nextToken

 The ID of the page in the paginated results.
 


limit
Integer limit

 The maximum number of Evaluation to include in the result.
 








Class com.amazonaws.services.machinelearning.model.DescribeEvaluationsResult extends Object implements Serializable




Serialized Fields


results
com.amazonaws.internal.SdkInternalList<T> results

 A list of Evaluation that meet the search criteria.
 


nextToken
String nextToken

 The ID of the next page in the paginated results that indicates at least
 one more page follows.
 








Class com.amazonaws.services.machinelearning.model.DescribeMLModelsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


filterVariable
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.
 


eQ
String eQ

 The equal to operator. The MLModel results will have
 FilterVariable values that exactly match the value specified
 with EQ.
 


gT
String gT

 The greater than operator. The MLModel results will have
 FilterVariable values that are greater than the value
 specified with GT.
 


lT
String lT

 The less than operator. The MLModel results will have
 FilterVariable values that are less than the value specified
 with LT.
 


gE
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.
 


lE
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.
 


nE
String nE

 The not equal to operator. The MLModel results will have
 FilterVariable values not equal to the value specified with
 NE.
 


prefix
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
 
 
 


sortOrder
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.
 


nextToken
String nextToken

 The ID of the page in the paginated results.
 


limit
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.
 








Class com.amazonaws.services.machinelearning.model.DescribeMLModelsResult extends Object implements Serializable




Serialized Fields


results
com.amazonaws.internal.SdkInternalList<T> results

 A list of MLModel that meet the search criteria.
 


nextToken
String nextToken

 The ID of the next page in the paginated results that indicates at least
 one more page follows.
 








Class com.amazonaws.services.machinelearning.model.Evaluation extends Object implements Serializable




Serialized Fields


evaluationId
String evaluationId

 The ID that is assigned to the Evaluation at creation.
 


mLModelId
String mLModelId

 The ID of the MLModel that is the focus of the evaluation.
 


evaluationDataSourceId
String evaluationDataSourceId

 The ID of the DataSource that is used to evaluate the
 MLModel.
 


inputDataLocationS3
String inputDataLocationS3

 The location and name of the data in Amazon Simple Storage Server (Amazon
 S3) that is used in the evaluation.
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time that the Evaluation was created. The time is
 expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the Evaluation. The time
 is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the Evaluation.
 


status
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 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.
 


message
String message

 A description of the most recent details about evaluating the
 MLModel.
 








Class com.amazonaws.services.machinelearning.model.GetBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 An ID assigned to the BatchPrediction at creation.
 








Class com.amazonaws.services.machinelearning.model.GetBatchPredictionResult extends Object implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 An ID assigned to the BatchPrediction at creation. This
 value should be identical to the value of the
 BatchPredictionID in the request.
 


mLModelId
String mLModelId

 The ID of the MLModel that generated predictions for the
 BatchPrediction request.
 


batchPredictionDataSourceId
String batchPredictionDataSourceId

 The ID of the DataSource that was used to create the
 BatchPrediction.
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage
 Service (Amazon S3).
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time when the BatchPrediction was created. The time is
 expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to BatchPrediction. The
 time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the BatchPrediction.
 


status
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.
 


outputUri
String outputUri

 The location of an Amazon S3 bucket or directory to receive the operation
 results.
 


logUri
String logUri

 A link to the file that contains logs of the CreateBatchPrediction
 operation.
 


message
String message

 A description of the most recent details about processing the batch
 prediction request.
 








Class com.amazonaws.services.machinelearning.model.GetDataSourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource at creation.
 


verbose
Boolean verbose

 Specifies whether the GetDataSource operation should return
 DataSourceSchema.
 
 
 If true, DataSourceSchema is returned.
 
 
 If false, DataSourceSchema is not returned.
 








Class com.amazonaws.services.machinelearning.model.GetDataSourceResult extends Object implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource at creation. This value
 should be identical to the value of the DataSourceId in the
 request.
 


dataLocationS3
String dataLocationS3

 The location of the data file or directory in Amazon Simple Storage
 Service (Amazon S3).
 


dataRearrangement
String dataRearrangement

 A JSON string that captures the splitting rearrangement requirement of
 the DataSource.
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time that the DataSource was created. The time is
 expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the DataSource. The time
 is expressed in epoch time.
 


dataSizeInBytes
Long dataSizeInBytes

 The total size of observations in the data files.
 


numberOfFiles
Long numberOfFiles

 The number of data files referenced by the DataSource.
 


name
String name

 A user-supplied name or description of the DataSource.
 


status
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.
 


logUri
String logUri

 A link to the file containining logs of either create
 DataSource operation.
 


message
String message

 The description of the most recent details about creating the
 DataSource.
 


redshiftMetadata
RedshiftMetadata redshiftMetadata


rDSMetadata
RDSMetadata rDSMetadata


roleARN
String roleARN


computeStatistics
Boolean computeStatistics

 The parameter is true if statistics need to be generated
 from the observation data.
 


dataSourceSchema
String dataSourceSchema

 The schema used by all of the data files of this DataSource.
 
 Note
 
 This parameter is provided as part of the verbose format.
 
 








Class com.amazonaws.services.machinelearning.model.GetEvaluationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


evaluationId
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.
 








Class com.amazonaws.services.machinelearning.model.GetEvaluationResult extends Object implements Serializable




Serialized Fields


evaluationId
String evaluationId

 The evaluation ID which is same as the EvaluationId in the
 request.
 


mLModelId
String mLModelId

 The ID of the MLModel that was the focus of the evaluation.
 


evaluationDataSourceId
String evaluationDataSourceId

 The DataSource used for this evaluation.
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage
 Service (Amazon S3).
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time that the Evaluation was created. The time is
 expressed in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the BatchPrediction. The
 time is expressed in epoch time.
 


name
String name

 A user-supplied name or description of the Evaluation.
 


status
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 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.
 


logUri
String logUri

 A link to the file that contains logs of the CreateEvaluation
 operation.
 


message
String message

 A description of the most recent details about evaluating the
 MLModel.
 








Class com.amazonaws.services.machinelearning.model.GetMLModelRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel at creation.
 


verbose
Boolean verbose

 Specifies whether the GetMLModel operation should return
 Recipe.
 
 
 If true, Recipe is returned.
 
 
 If false, Recipe is not returned.
 








Class com.amazonaws.services.machinelearning.model.GetMLModelResult extends Object implements Serializable




Serialized Fields


mLModelId
String mLModelId

 The MLModel ID which is same as the MLModelId in the
 request.
 


trainingDataSourceId
String trainingDataSourceId

 The ID of the training DataSource.
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time that the MLModel was created. The time is expressed
 in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the MLModel. The time is
 expressed in epoch time.
 


name
String name

 A user-supplied name or description of the MLModel.
 


status
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.
 


sizeInBytes
Long sizeInBytes


endpointInfo
RealtimeEndpointInfo endpointInfo

 The current endpoint of the MLModel
 


trainingParameters
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.
 
 
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage
 Service (Amazon S3).
 


mLModelType
String mLModelType

 Identifies the MLModel category. The following are the
 available types:
 
 
 REGRESSION -- Produces a numeric result. For example,
 "What listing price should a house have?"
 BINARY -- Produces one of two possible results. For example,
 "Is this an e-commerce website?"
 MULTICLASS -- Produces more than two possible results. For example,
 "Is this a HIGH, LOW or MEDIUM risk trade?"
 


scoreThreshold
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.
 


scoreThresholdLastUpdatedAt
Date scoreThresholdLastUpdatedAt

 The time of the most recent edit to the ScoreThreshold. The
 time is expressed in epoch time.
 


logUri
String logUri

 A link to the file that contains logs of the CreateMLModel
 operation.
 


message
String message

 Description of the most recent details about accessing the
 MLModel.
 


recipe
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.
 
 Note
 
 This parameter is provided as part of the verbose format.
 
 


schema
String schema

 The schema used by all of the data files referenced by the
 DataSource.
 
 Note
 
 This parameter is provided as part of the verbose format.
 
 








Class com.amazonaws.services.machinelearning.model.IdempotentParameterMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.MLModel extends Object implements Serializable




Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel at creation.
 


trainingDataSourceId
String trainingDataSourceId

 The ID of the training DataSource. The CreateMLModel
 operation uses the TrainingDataSourceId.
 


createdByIamUser
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.
 


createdAt
Date createdAt

 The time that the MLModel was created. The time is expressed
 in epoch time.
 


lastUpdatedAt
Date lastUpdatedAt

 The time of the most recent edit to the MLModel. The time is
 expressed in epoch time.
 


name
String name

 A user-supplied name or description of the MLModel.
 


status
String status

 The current status of an MLModel. This element can have one
 of the following values:
 
 
 PENDING - Amazon Machine Learning (Amazon ML) submitted a request to
 create an MLModel.
 INPROGRESS - The creation process is underway.
 FAILED - The request to create an MLModel did not run to
 completion. It is not usable.
 COMPLETED - The creation process completed successfully.
 DELETED - The MLModel is marked as deleted. It is not
 usable.
 


sizeInBytes
Long sizeInBytes


endpointInfo
RealtimeEndpointInfo endpointInfo

 The current endpoint of the MLModel.
 


trainingParameters
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.
 
 
 


inputDataLocationS3
String inputDataLocationS3

 The location of the data file or directory in Amazon Simple Storage
 Service (Amazon S3).
 


algorithm
String algorithm

 The algorithm used to train the MLModel. The following
 algorithm is supported:
 
 
 SGD -- Stochastic gradient descent. The goal of SGD is to minimize
 the gradient of the loss function.
 


mLModelType
String mLModelType

 Identifies the MLModel category. The following are the
 available types:
 
 
 REGRESSION - Produces a numeric result. For example,
 "What listing price should a house have?".
 BINARY - Produces one of two possible results. For example,
 "Is this a child-friendly web site?".
 MULTICLASS - Produces more than two possible results. For example,
 "Is this a HIGH, LOW or MEDIUM risk trade?".
 


scoreThreshold
Float scoreThreshold


scoreThresholdLastUpdatedAt
Date scoreThresholdLastUpdatedAt

 The time of the most recent edit to the ScoreThreshold. The
 time is expressed in epoch time.
 


message
String message

 A description of the most recent details about accessing the
 MLModel.
 








Class com.amazonaws.services.machinelearning.model.PerformanceMetrics extends Object implements Serializable




Serialized Fields


properties
com.amazonaws.internal.SdkInternalMap<K,V> properties








Class com.amazonaws.services.machinelearning.model.Prediction extends Object implements Serializable




Serialized Fields


predictedLabel
String predictedLabel
The prediction label for either a BINARY or MULTICLASS
 MLModel.


predictedValue
Float predictedValue
The prediction value for REGRESSION MLModel.


predictedScores
com.amazonaws.internal.SdkInternalMap<K,V> predictedScores


details
com.amazonaws.internal.SdkInternalMap<K,V> details








Class com.amazonaws.services.machinelearning.model.PredictorNotMountedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.machinelearning.model.PredictRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mLModelId
String mLModelId

 A unique identifier of the MLModel.
 


record
com.amazonaws.internal.SdkInternalMap<K,V> record


predictEndpoint
String predictEndpoint








Class com.amazonaws.services.machinelearning.model.PredictResult extends Object implements Serializable




Serialized Fields


prediction
Prediction prediction








Class com.amazonaws.services.machinelearning.model.RDSDatabase extends Object implements Serializable




Serialized Fields


instanceIdentifier
String instanceIdentifier

 The ID of an RDS DB instance.
 


databaseName
String databaseName








Class com.amazonaws.services.machinelearning.model.RDSDatabaseCredentials extends Object implements Serializable




Serialized Fields


username
String username


password
String password








Class com.amazonaws.services.machinelearning.model.RDSDataSpec extends Object implements Serializable




Serialized Fields


databaseInformation
RDSDatabase databaseInformation

 Describes the DatabaseName and
 InstanceIdentifier of an an Amazon RDS database.
 


selectSqlQuery
String selectSqlQuery

 The query that is used to retrieve the observation data for the
 DataSource.
 


databaseCredentials
RDSDatabaseCredentials databaseCredentials

 The AWS Identity and Access Management (IAM) credentials that are used
 connect to the Amazon RDS database.
 


s3StagingLocation
String s3StagingLocation

 The Amazon S3 location for staging Amazon RDS data. The data retrieved
 from Amazon RDS using SelectSqlQuery is stored in this
 location.
 


dataRearrangement
String dataRearrangement

 DataRearrangement - A JSON string that represents the splitting
 requirement of a DataSource.
 
 

 
 Sample -
  "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
 


dataSchema
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" ] }
 
 


dataSchemaUri
String dataSchemaUri

 The Amazon S3 location of the DataSchema.
 


resourceRole
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.
 


serviceRole
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.
 


subnetId
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.
 


securityGroupIds
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.
 








Class com.amazonaws.services.machinelearning.model.RDSMetadata extends Object implements Serializable




Serialized Fields


database
RDSDatabase database

 The database details required to connect to an Amazon RDS.
 


databaseUserName
String databaseUserName


selectSqlQuery
String selectSqlQuery

 The SQL query that is supplied during CreateDataSourceFromRDS.
 Returns only if Verbose is true in
 GetDataSourceInput.
 


resourceRole
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.
 


serviceRole
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.
 


dataPipelineId
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.
 








Class com.amazonaws.services.machinelearning.model.RealtimeEndpointInfo extends Object implements Serializable




Serialized Fields


peakRequestsPerSecond
Integer peakRequestsPerSecond

 The maximum processing rate for the real-time endpoint for
 MLModel, measured in incoming requests per second.
 


createdAt
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.
 


endpointUrl
String endpointUrl

 The URI that specifies where to send real-time prediction requests for
 the MLModel.
 
 Note
 
 The application must wait until the real-time endpoint is ready before
 using this URI.
 
 


endpointStatus
String endpointStatus

 The current status of the real-time endpoint for the MLModel
 . This element can have one of the following values:
 
 
 NONE - Endpoint does not exist or was previously deleted.
 READY - Endpoint is ready to be used for real-time predictions.
 UPDATING - Updating/creating the endpoint.
 








Class com.amazonaws.services.machinelearning.model.RedshiftDatabase extends Object implements Serializable




Serialized Fields


databaseName
String databaseName


clusterIdentifier
String clusterIdentifier








Class com.amazonaws.services.machinelearning.model.RedshiftDatabaseCredentials extends Object implements Serializable




Serialized Fields


username
String username


password
String password








Class com.amazonaws.services.machinelearning.model.RedshiftDataSpec extends Object implements Serializable




Serialized Fields


databaseInformation
RedshiftDatabase databaseInformation

 Describes the DatabaseName and
 ClusterIdentifier for an Amazon Redshift
 DataSource.
 


selectSqlQuery
String selectSqlQuery

 Describes the SQL Query to execute on an Amazon Redshift database for an
 Amazon Redshift DataSource.
 


databaseCredentials
RedshiftDatabaseCredentials databaseCredentials

 Describes AWS Identity and Access Management (IAM) credentials that are
 used connect to the Amazon Redshift database.
 


s3StagingLocation
String s3StagingLocation

 Describes an Amazon S3 location to store the result set of the
 SelectSqlQuery query.
 


dataRearrangement
String dataRearrangement

 Describes the splitting specifications for a DataSource.
 


dataSchema
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" ] }
 


dataSchemaUri
String dataSchemaUri

 Describes the schema location for an Amazon Redshift
 DataSource.
 








Class com.amazonaws.services.machinelearning.model.RedshiftMetadata extends Object implements Serializable




Serialized Fields


redshiftDatabase
RedshiftDatabase redshiftDatabase


databaseUserName
String databaseUserName


selectSqlQuery
String selectSqlQuery

 The SQL query that is specified during
 CreateDataSourceFromRedshift. Returns only if Verbose
 is true in GetDataSourceInput.
 








Class com.amazonaws.services.machinelearning.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Serialized Fields


code
Integer code








Class com.amazonaws.services.machinelearning.model.S3DataSpec extends Object implements Serializable




Serialized Fields


dataLocationS3
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.
 


dataRearrangement
String dataRearrangement

 Describes the splitting requirement of a Datasource.
 


dataSchema
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" ] }
 
 


dataSchemaLocationS3
String dataSchemaLocationS3

 Describes the schema Location in Amazon S3.
 








Class com.amazonaws.services.machinelearning.model.UpdateBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 The ID assigned to the BatchPrediction during creation.
 


batchPredictionName
String batchPredictionName

 A new user-supplied name or description of the
 BatchPrediction.
 








Class com.amazonaws.services.machinelearning.model.UpdateBatchPredictionResult extends Object implements Serializable




Serialized Fields


batchPredictionId
String batchPredictionId

 The ID assigned to the BatchPrediction during creation. This
 value should be identical to the value of the
 BatchPredictionId in the request.
 








Class com.amazonaws.services.machinelearning.model.UpdateDataSourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource during creation.
 


dataSourceName
String dataSourceName

 A new user-supplied name or description of the DataSource
 that will replace the current description.
 








Class com.amazonaws.services.machinelearning.model.UpdateDataSourceResult extends Object implements Serializable




Serialized Fields


dataSourceId
String dataSourceId

 The ID assigned to the DataSource during creation. This
 value should be identical to the value of the DataSourceID
 in the request.
 








Class com.amazonaws.services.machinelearning.model.UpdateEvaluationRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


evaluationId
String evaluationId

 The ID assigned to the Evaluation during creation.
 


evaluationName
String evaluationName

 A new user-supplied name or description of the Evaluation
 that will replace the current content.
 








Class com.amazonaws.services.machinelearning.model.UpdateEvaluationResult extends Object implements Serializable




Serialized Fields


evaluationId
String evaluationId

 The ID assigned to the Evaluation during creation. This
 value should be identical to the value of the Evaluation in
 the request.
 








Class com.amazonaws.services.machinelearning.model.UpdateMLModelRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel during creation.
 


mLModelName
String mLModelName

 A user-supplied name or description of the MLModel.
 


scoreThreshold
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.
 








Class com.amazonaws.services.machinelearning.model.UpdateMLModelResult extends Object implements Serializable




Serialized Fields


mLModelId
String mLModelId

 The ID assigned to the MLModel during creation. This value
 should be identical to the value of the MLModelID in the
 request.
 








Package com.amazonaws.services.marketplacecommerceanalytics.model




Class com.amazonaws.services.marketplacecommerceanalytics.model.GenerateDataSetRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dataSetType
String dataSetType

 The desired data set type.
 
 
 

 customer_subscriber_hourly_monthly_subscriptions - Available
 daily by 5:00 PM Pacific Time since 2014-07-21.
 customer_subscriber_annual_subscriptions - Available daily by
 5:00 PM Pacific Time since 2014-07-21.
 daily_business_usage_by_instance_type - Available daily by
 5:00 PM Pacific Time since 2015-01-26.
 daily_business_fees - Available daily by 5:00 PM Pacific Time
 since 2015-01-26.
 daily_business_free_trial_conversions - Available daily by
 5:00 PM Pacific Time since 2015-01-26.
 daily_business_new_instances - Available daily by 5:00 PM
 Pacific Time since 2015-01-26.
 daily_business_new_product_subscribers - Available daily by
 5:00 PM Pacific Time since 2015-01-26.
 daily_business_canceled_product_subscribers - Available daily
 by 5:00 PM Pacific Time since 2015-01-26.
 monthly_revenue_billing_and_revenue_data - Available monthly
 on the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
 monthly_revenue_annual_subscriptions - Available monthly on
 the 4th day of the month by 5:00 PM Pacific Time since 2015-02.
 disbursed_amount_by_product - Available every 30 days by 5:00
 PM Pacific Time since 2015-01-26.
 disbursed_amount_by_product_with_uncollected_funds -This data
 set is only available from 2012-04-19 until 2015-01-25. After 2015-01-25,
 this data set was split into three data sets:
 disbursed_amount_by_product,
 disbursed_amount_by_age_of_uncollected_funds, and
 disbursed_amount_by_age_of_disbursed_funds.
 disbursed_amount_by_customer_geo - Available every 30 days by
 5:00 PM Pacific Time since 2012-04-19.
 disbursed_amount_by_age_of_uncollected_funds - Available every
 30 days by 5:00 PM Pacific Time since 2015-01-26.
 disbursed_amount_by_age_of_disbursed_funds - Available every
 30 days by 5:00 PM Pacific Time since 2015-01-26.
 customer_profile_by_industry - Available daily by 5:00 PM
 Pacific Time since 2015-10-01.
 customer_profile_by_revenue - Available daily by 5:00 PM
 Pacific Time since 2015-10-01.
 customer_profile_by_geography - Available daily by 5:00 PM
 Pacific Time since 2015-10-01.
 
 


dataSetPublicationDate
Date dataSetPublicationDate
The date a data set was published. For daily data sets, provide a date
 with day-level granularity for the desired day. For weekly data sets,
 provide a date with day-level granularity within the desired week (the day
 value will be ignored). For monthly data sets, provide a date with
 month-level granularity for the desired month (the day value will be
 ignored).


roleNameArn
String roleNameArn
The Amazon Resource Name (ARN) of the Role with an attached permissions
 policy to interact with the provided AWS services.


destinationS3BucketName
String destinationS3BucketName
The name (friendly name, not ARN) of the destination S3 bucket.


destinationS3Prefix
String destinationS3Prefix
(Optional) The desired S3 prefix for the published data set, similar to a
 directory path in standard file systems. For example, if given the bucket
 name "mybucket" and the prefix "myprefix/mydatasets", the output file
 "outputfile" would be published to
 "s3://mybucket/myprefix/mydatasets/outputfile". If the prefix directory
 structure does not exist, it will be created. If no prefix is provided,
 the data set will be published to the S3 bucket root.


snsTopicArn
String snsTopicArn
Amazon Resource Name (ARN) for the SNS Topic that will be notified when
 the data set has been published or if an error has occurred.


customerDefinedValues
Map<K,V> customerDefinedValues
(Optional) Key-value pairs which will be returned, unmodified, in the
 Amazon SNS notification message and the data set metadata file. These
 key-value pairs can be used to correlated responses with tracking
 information from other systems.








Class com.amazonaws.services.marketplacecommerceanalytics.model.GenerateDataSetResult extends Object implements Serializable




Serialized Fields


dataSetRequestId
String dataSetRequestId
A unique identifier representing a specific request to the
 GenerateDataSet operation. This identifier can be used to correlate a
 request with notifications from the SNS topic.








Class com.amazonaws.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.marketplacemetering.model




Class com.amazonaws.services.marketplacemetering.model.DuplicateRequestException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InternalServiceErrorException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidEndpointRegionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidProductCodeException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.InvalidUsageDimensionException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.MeterUsageRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


productCode
String productCode

 Product code is used to uniquely identify a product in AWS Marketplace.
 The product code should be the same as the one used during the publishing
 of a new product.
 


timestamp
Date timestamp

 Timestamp of the hour, recorded in UTC. The seconds and milliseconds
 portions of the timestamp will be ignored.
 


usageDimension
String usageDimension

 It will be one of the 'fcp dimension name' provided during the publishing
 of the product.
 


usageQuantity
Integer usageQuantity

 Consumption value for the hour.
 


dryRun
Boolean dryRun

 Checks whether you have the permissions required for the action, but does
 not make the request. If you have the permissions, the request returns
 DryRunOperation; otherwise, it returns UnauthorizedException.
 








Class com.amazonaws.services.marketplacemetering.model.MeterUsageResult extends Object implements Serializable




Serialized Fields


meteringRecordId
String meteringRecordId








Class com.amazonaws.services.marketplacemetering.model.ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.marketplacemetering.model.TimestampOutOfBoundsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Package com.amazonaws.services.opsworks.model




Class com.amazonaws.services.opsworks.model.AgentVersion extends Object implements Serializable




Serialized Fields


version
String version

 The agent version.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager.
 








Class com.amazonaws.services.opsworks.model.App extends Object implements Serializable




Serialized Fields


appId
String appId

 The app ID.
 


stackId
String stackId

 The app stack ID.
 


shortname
String shortname

 The app's short name.
 


name
String name

 The app name.
 


description
String description

 A description of the app.
 


dataSources
com.amazonaws.internal.SdkInternalList<T> dataSources

 The app's data sources.
 


type
String type

 The app type.
 


appSource
Source appSource

 A Source object that describes the app repository.
 


domains
com.amazonaws.internal.SdkInternalList<T> domains

 The app vhost settings with multiple domains separated by commas. For
 example: 'www.example.com, example.com'
 


enableSsl
Boolean enableSsl

 Whether to enable SSL for the app.
 


sslConfiguration
SslConfiguration sslConfiguration

 An SslConfiguration object with the SSL configuration.
 


attributes
com.amazonaws.internal.SdkInternalMap<K,V> attributes

 The stack attributes.
 


createdAt
String createdAt

 When the app was created.
 


environment
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,
 but if you do exceed it, you will cause an exception (API) with an
 "Environment: is too large (maximum is 10KB)" message. 








Class com.amazonaws.services.opsworks.model.AssignInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 


layerIds
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.
 








Class com.amazonaws.services.opsworks.model.AssignVolumeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


volumeId
String volumeId

 The volume ID.
 


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.AssociateElasticIpRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.AttachElasticLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


elasticLoadBalancerName
String elasticLoadBalancerName

 The Elastic Load Balancing instance's name.
 


layerId
String layerId

 The ID of the layer that the Elastic Load Balancing instance is to be
 attached to.
 








Class com.amazonaws.services.opsworks.model.AutoScalingThresholds extends Object implements Serializable




Serialized Fields


instanceCount
Integer instanceCount

 The number of instances to add or remove when the load exceeds a
 threshold.
 


thresholdsWaitTime
Integer thresholdsWaitTime

 The amount of time, in minutes, that the load must exceed a threshold
 before more instances are added or removed.
 


ignoreMetricsTime
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.
 


cpuThreshold
Double cpuThreshold

 The CPU utilization threshold, as a percent of the available CPU. A value
 of -1 disables the threshold.
 


memoryThreshold
Double memoryThreshold

 The memory utilization threshold, as a percent of the available memory. A
 value of -1 disables the threshold.
 


loadThreshold
Double loadThreshold

 The load threshold. A value of -1 disables the threshold. For more
 information about how load is computed, see Load
 (computing).
 


alarms
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.
 
 To use custom alarms, you must update your service role to allow
 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.








Class com.amazonaws.services.opsworks.model.BlockDeviceMapping extends Object implements Serializable




Serialized Fields


deviceName
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.
 


noDevice
String noDevice

 Suppresses the specified device included in the AMI's block device
 mapping.
 


virtualName
String virtualName

 The virtual device name. For more information, see BlockDeviceMapping.
 


ebs
EbsBlockDevice ebs

 An EBSBlockDevice that defines how to configure an Amazon
 EBS volume when the instance is launched.
 








Class com.amazonaws.services.opsworks.model.ChefConfiguration extends Object implements Serializable




Serialized Fields


manageBerkshelf
Boolean manageBerkshelf

 Whether to enable Berkshelf.
 


berkshelfVersion
String berkshelfVersion

 The Berkshelf version.
 








Class com.amazonaws.services.opsworks.model.CloneStackRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceStackId
String sourceStackId

 The source stack ID.
 


name
String name

 The cloned stack name.
 


region
String region

 The cloned stack AWS region, such as "us-east-1". For more information
 about AWS regions, see Regions
 and Endpoints.
 


vpcId
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 your account supports EC2 Classic, the default value is no VPC.
 If your account does not support EC2 Classic, the default value is
 the default VPC for the specified region.
 
 
 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:
 
 
 It must belong to a VPC in your account that is in the specified
 region.
 You must specify a value for 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.
 


attributes
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.
 


serviceRoleArn
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.
 
 


defaultInstanceProfileArn
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.
 


defaultOs
String defaultOs

 The stack's operating system, which must be set to one of the following.
 
 
 A supported Linux operating system: An Amazon Linux version, such as
 Amazon Linux 2015.03,
 Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
 or Ubuntu 14.04 LTS.
 Microsoft Windows Server 2012 R2 Base.
 A custom AMI: 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.
 
 You can specify a different Linux operating system for the cloned
 stack, but you cannot change from Linux to Windows or Windows to
 Linux.


hostnameTheme
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_Goods
  Clouds
  Europe_Cities
  Fruits
  Greek_Deities
  Legendary_creatures_from_Japan
  Planets_and_Moons
  Roman_Deities
  Scottish_Islands
  US_Cities
  Wild_Cats
 
 
 To obtain a generated host name, call GetHostNameSuggestion,
 which returns a host name based on the current theme.
 


defaultAvailabilityZone
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.
 


defaultSubnetId
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.
 


customJson
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
 


configurationManager
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 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.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether to use custom cookbooks.
 


useOpsworksSecurityGroups
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:
 
 
 True - AWS OpsWorks automatically associates the appropriate built-in
 security group with each layer (default setting). You can associate
 additional security groups with a layer after you create it but you
 cannot delete the built-in security group.
 False - AWS OpsWorks does not associate built-in security groups with
 layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon
 EC2) security groups and associate a security group with each layer that
 you create. However, you can still manually associate a built-in security
 group with a layer on creation; custom security groups are required only
 for those layers that need custom settings.
 
 
 For more information, see Create a New Stack.
 


customCookbooksSource
Source customCookbooksSource


defaultSshKeyName
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.
 


clonePermissions
Boolean clonePermissions

 Whether to clone the source stack's permissions.
 


cloneAppIds
com.amazonaws.internal.SdkInternalList<T> cloneAppIds

 A list of source stack app IDs to be included in the cloned stack.
 


defaultRootDeviceType
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.
 


agentVersion
String agentVersion

 The default AWS OpsWorks agent version. You have the following options:
 
 
 Auto-update - Set this parameter to LATEST. AWS OpsWorks
 automatically installs new agent versions on the stack's instances as
 soon as they are available.
 Fixed version - Set this parameter to your preferred agent version.
 To update the agent version, you must edit the stack configuration and
 specify a new version. AWS OpsWorks then automatically installs that
 version on the stack's instances.
 
 
 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.
 
 You can also specify an agent version when you create or update an
 instance, which overrides the stack's default setting.








Class com.amazonaws.services.opsworks.model.CloneStackResult extends Object implements Serializable




Serialized Fields


stackId
String stackId

 The cloned stack ID.
 








Class com.amazonaws.services.opsworks.model.Command extends Object implements Serializable




Serialized Fields


commandId
String commandId

 The command ID.
 


instanceId
String instanceId

 The ID of the instance where the command was executed.
 


deploymentId
String deploymentId

 The command deployment ID.
 


createdAt
String createdAt

 Date and time when the command was run.
 


acknowledgedAt
String acknowledgedAt

 Date and time when the command was acknowledged.
 


completedAt
String completedAt

 Date when the command completed.
 


status
String status

 The command status:
 
 
 failed
 successful
 skipped
 pending
 


exitCode
Integer exitCode

 The command exit code.
 


logUrl
String logUrl

 The URL of the command log.
 


type
String type

 The command type:
 
 
  deploy
  rollback
  start
  stop
  restart
  undeploy
  update_dependencies
  install_dependencies
  update_custom_cookbooks
  execute_recipes
 








Class com.amazonaws.services.opsworks.model.CreateAppRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


shortname
String shortname

 The app's short name.
 


name
String name

 The app name.
 


description
String description

 A description of the app.
 


dataSources
com.amazonaws.internal.SdkInternalList<T> dataSources

 The app's data source.
 


type
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.
 


appSource
Source appSource

 A Source object that specifies the app repository.
 


domains
com.amazonaws.internal.SdkInternalList<T> domains

 The app virtual host settings, with multiple domains separated by commas.
 For example: 'www.example.com, example.com'
 


enableSsl
Boolean enableSsl

 Whether to enable SSL for the app.
 


sslConfiguration
SslConfiguration sslConfiguration

 An SslConfiguration object with the SSL configuration.
 


attributes
com.amazonaws.internal.SdkInternalMap<K,V> attributes

 One or more user-defined key/value pairs to be added to the stack
 attributes.
 


environment
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)."
 
 This parameter is supported only by Chef 11.10 stacks. If you have
 specified one or more environment variables, you cannot modify the
 stack's Chef version.








Class com.amazonaws.services.opsworks.model.CreateAppResult extends Object implements Serializable




Serialized Fields


appId
String appId

 The app ID.
 








Class com.amazonaws.services.opsworks.model.CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


appId
String appId

 The app ID. This parameter is required for app deployments, but not for
 other deployment commands.
 


instanceIds
com.amazonaws.internal.SdkInternalList<T> instanceIds

 The instance IDs for the deployment targets.
 


command
DeploymentCommand command

 A DeploymentCommand object that specifies the deployment
 command and any associated arguments.
 


comment
String comment

 A user-defined comment.
 


customJson
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.
 








Class com.amazonaws.services.opsworks.model.CreateDeploymentResult extends Object implements Serializable




Serialized Fields


deploymentId
String deploymentId

 The deployment ID, which can be used with other requests to identify the
 deployment.
 








Class com.amazonaws.services.opsworks.model.CreateInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


layerIds
com.amazonaws.internal.SdkInternalList<T> layerIds

 An array that contains the instance's layer IDs.
 


instanceType
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.
 


autoScalingType
String autoScalingType

 For load-based or time-based instances, the type. Windows stacks can use
 only time-based instances.
 


hostname
String hostname

 The instance host name.
 


os
String os

 The instance's operating system, which must be set to one of the
 following.
 
 
 A supported Linux operating system: An Amazon Linux version, such as
 Amazon Linux 2015.03,
 Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
 or Ubuntu 14.04 LTS.
 Microsoft Windows Server 2012 R2 Base.
 A custom AMI: 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.
 


amiId
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.
 
 If you specify a custom AMI, you must set Os to
 Custom.


sshKeyName
String sshKeyName

 The instance's Amazon EC2 key-pair name.
 


availabilityZone
String availabilityZone

 The instance Availability Zone. For more information, see Regions
 and Endpoints.
 


virtualizationType
String virtualizationType

 The instance's virtualization type, paravirtual or
 hvm.
 


subnetId
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.
 


architecture
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.
 


rootDeviceType
String rootDeviceType

 The instance root device type. For more information, see Storage for the Root Device.
 


blockDeviceMappings
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.
 


installUpdatesOnBoot
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.
 
 


ebsOptimized
Boolean ebsOptimized

 Whether to create an Amazon EBS-optimized instance.
 


agentVersion
String agentVersion

 The default AWS OpsWorks agent version. You have the following options:
 
 
 INHERIT - Use the stack's default agent version setting.
 
 version_number - Use the specified agent version. This value
 overrides the stack's default setting. To update the agent version, edit
 the instance configuration and specify a new version. AWS OpsWorks then
 automatically installs that version on the instance.
 
 
 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.
 








Class com.amazonaws.services.opsworks.model.CreateInstanceResult extends Object implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.CreateLayerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The layer stack ID.
 


type
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.
 


name
String name

 The layer name, which is used by the console.
 


shortname
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.
 


attributes
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.
 


customInstanceProfileArn
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.
 


customJson
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.
 


customSecurityGroupIds
com.amazonaws.internal.SdkInternalList<T> customSecurityGroupIds

 An array containing the layer custom security group IDs.
 


packages
com.amazonaws.internal.SdkInternalList<T> packages

 An array of Package objects that describes the layer
 packages.
 


volumeConfigurations
com.amazonaws.internal.SdkInternalList<T> volumeConfigurations

 A VolumeConfigurations object that describes the layer's
 Amazon EBS volumes.
 


enableAutoHealing
Boolean enableAutoHealing

 Whether to disable auto healing for the layer.
 


autoAssignElasticIps
Boolean autoAssignElasticIps

 Whether to automatically assign an Elastic IP address to the layer's instances. For more information,
 see How to Edit a Layer.
 


autoAssignPublicIps
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.
 


customRecipes
Recipes customRecipes

 A LayerCustomRecipes object that specifies the layer custom
 recipes.
 


installUpdatesOnBoot
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.
 
 


useEbsOptimizedInstances
Boolean useEbsOptimizedInstances

 Whether to use Amazon EBS-optimized instances.
 


lifecycleEventConfiguration
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.
 








Class com.amazonaws.services.opsworks.model.CreateLayerResult extends Object implements Serializable




Serialized Fields


layerId
String layerId

 The layer ID.
 








Class com.amazonaws.services.opsworks.model.CreateStackRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


name
String name

 The stack name.
 


region
String region

 The stack's AWS region, such as "us-east-1". For more information about
 Amazon regions, see Regions
 and Endpoints.
 


vpcId
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.
 
 
 If your account supports EC2-Classic, the default value is
 no VPC.
 If your account does not support EC2-Classic, the default value is
 the default VPC for the specified region.
 
 
 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:
 
 
 It must belong to a VPC in your account that is in the specified
 region.
 You must specify a value for 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.
 


attributes
com.amazonaws.internal.SdkInternalMap<K,V> attributes

 One or more user-defined key-value pairs to be added to the stack
 attributes.
 


serviceRoleArn
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.
 


defaultInstanceProfileArn
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.
 


defaultOs
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.
 
 
 A supported Linux operating system: An Amazon Linux version, such as
 Amazon Linux 2015.03,
 Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
 or Ubuntu 14.04 LTS.
 Microsoft Windows Server 2012 R2 Base.
 A custom AMI: 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.
 


hostnameTheme
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_Goods
  Clouds
  Europe_Cities
  Fruits
  Greek_Deities
  Legendary_creatures_from_Japan
  Planets_and_Moons
  Roman_Deities
  Scottish_Islands
  US_Cities
  Wild_Cats
 
 
 To obtain a generated host name, call GetHostNameSuggestion,
 which returns a host name based on the current theme.
 


defaultAvailabilityZone
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.
 


defaultSubnetId
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.
 


customJson
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.
 


configurationManager
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 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.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether the stack uses custom cookbooks.
 


useOpsworksSecurityGroups
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:
 
 
 True - AWS OpsWorks automatically associates the appropriate built-in
 security group with each layer (default setting). You can associate
 additional security groups with a layer after you create it, but you
 cannot delete the built-in security group.
 False - AWS OpsWorks does not associate built-in security groups with
 layers. You must create appropriate EC2 security groups and associate a
 security group with each layer that you create. However, you can still
 manually associate a built-in security group with a layer on creation;
 custom security groups are required only for those layers that need
 custom settings.
 
 
 For more information, see Create a New Stack.
 


customCookbooksSource
Source customCookbooksSource


defaultSshKeyName
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.
 


defaultRootDeviceType
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.
 


agentVersion
String agentVersion

 The default AWS OpsWorks agent version. You have the following options:
 
 
 Auto-update - Set this parameter to LATEST. AWS OpsWorks
 automatically installs new agent versions on the stack's instances as
 soon as they are available.
 Fixed version - Set this parameter to your preferred agent version.
 To update the agent version, you must edit the stack configuration and
 specify a new version. AWS OpsWorks then automatically installs that
 version on the stack's instances.
 
 
 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.
 
 You can also specify an agent version when you create or update an
 instance, which overrides the stack's default setting.








Class com.amazonaws.services.opsworks.model.CreateStackResult extends Object implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID, which is an opaque string that you use to identify the
 stack when performing actions such as DescribeStacks.
 








Class com.amazonaws.services.opsworks.model.CreateUserProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


sshUsername
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.
 


sshPublicKey
String sshPublicKey

 The user's public SSH key.
 


allowSelfManagement
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.
 








Class com.amazonaws.services.opsworks.model.CreateUserProfileResult extends Object implements Serializable




Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 








Class com.amazonaws.services.opsworks.model.DataSource extends Object implements Serializable




Serialized Fields


type
String type

 The data source's type, AutoSelectOpsworksMysqlInstance,
 OpsworksMysqlInstance, or RdsDbInstance.
 


arn
String arn

 The data source's ARN.
 


databaseName
String databaseName

 The database name.
 








Class com.amazonaws.services.opsworks.model.DeleteAppRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


appId
String appId

 The app ID.
 








Class com.amazonaws.services.opsworks.model.DeleteInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 


deleteElasticIp
Boolean deleteElasticIp

 Whether to delete the instance Elastic IP address.
 


deleteVolumes
Boolean deleteVolumes

 Whether to delete the instance's Amazon EBS volumes.
 








Class com.amazonaws.services.opsworks.model.DeleteLayerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


layerId
String layerId

 The layer ID.
 








Class com.amazonaws.services.opsworks.model.DeleteStackRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.DeleteUserProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 








Class com.amazonaws.services.opsworks.model.Deployment extends Object implements Serializable




Serialized Fields


deploymentId
String deploymentId

 The deployment ID.
 


stackId
String stackId

 The stack ID.
 


appId
String appId

 The app ID.
 


createdAt
String createdAt

 Date when the deployment was created.
 


completedAt
String completedAt

 Date when the deployment completed.
 


duration
Integer duration

 The deployment duration.
 


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


comment
String comment

 A user-defined comment.
 


command
DeploymentCommand command


status
String status

 The deployment status:
 
 
 running
 successful
 failed
 


customJson
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.
 


instanceIds
com.amazonaws.internal.SdkInternalList<T> instanceIds

 The IDs of the target instances.
 








Class com.amazonaws.services.opsworks.model.DeploymentCommand extends Object implements Serializable




Serialized Fields


name
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.
 
 The update_dependencies and install_dependencies commands are
 supported only for Linux instances. You can run the commands successfully
 on Windows instances, but they do nothing.
 
 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.
 


args
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"] } 








Class com.amazonaws.services.opsworks.model.DeregisterEcsClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's ARN.
 








Class com.amazonaws.services.opsworks.model.DeregisterElasticIpRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 








Class com.amazonaws.services.opsworks.model.DeregisterInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.DeregisterRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


rdsDbInstanceArn
String rdsDbInstanceArn

 The Amazon RDS instance's ARN.
 








Class com.amazonaws.services.opsworks.model.DeregisterVolumeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


volumeId
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.
 








Class com.amazonaws.services.opsworks.model.DescribeAgentVersionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager.
 








Class com.amazonaws.services.opsworks.model.DescribeAgentVersionsResult extends Object implements Serializable




Serialized Fields


agentVersions
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.
 








Class com.amazonaws.services.opsworks.model.DescribeAppsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The app stack ID. If you use this parameter, DescribeApps
 returns a description of the apps in the specified stack.
 


appIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeAppsResult extends Object implements Serializable




Serialized Fields


apps
com.amazonaws.internal.SdkInternalList<T> apps

 An array of App objects that describe the specified apps.
 








Class com.amazonaws.services.opsworks.model.DescribeCommandsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


deploymentId
String deploymentId

 The deployment ID. If you include this parameter,
 DescribeCommands returns a description of the commands
 associated with the specified deployment.
 


instanceId
String instanceId

 The instance ID. If you include this parameter,
 DescribeCommands returns a description of the commands
 associated with the specified instance.
 


commandIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeCommandsResult extends Object implements Serializable




Serialized Fields


commands
com.amazonaws.internal.SdkInternalList<T> commands

 An array of Command objects that describe each of the
 specified commands.
 








Class com.amazonaws.services.opsworks.model.DescribeDeploymentsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID. If you include this parameter,
 DescribeDeployments returns a description of the commands
 associated with the specified stack.
 


appId
String appId

 The app ID. If you include this parameter,
 DescribeDeployments returns a description of the commands
 associated with the specified app.
 


deploymentIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeDeploymentsResult extends Object implements Serializable




Serialized Fields


deployments
com.amazonaws.internal.SdkInternalList<T> deployments

 An array of Deployment objects that describe the
 deployments.
 








Class com.amazonaws.services.opsworks.model.DescribeEcsClustersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ecsClusterArns
com.amazonaws.internal.SdkInternalList<T> ecsClusterArns

 A list of ARNs, one for each cluster to be described.
 


stackId
String stackId

 A stack ID. DescribeEcsClusters returns a description of the
 cluster that is registered with the stack.
 


nextToken
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.
 


maxResults
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.
 








Class com.amazonaws.services.opsworks.model.DescribeEcsClustersResult extends Object implements Serializable




Serialized Fields


ecsClusters
com.amazonaws.internal.SdkInternalList<T> ecsClusters

 A list of EcsCluster objects containing the cluster
 descriptions.
 


nextToken
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.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticIpsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID. If you include this parameter,
 DescribeElasticIps returns a description of the Elastic IP
 addresses associated with the specified instance.
 


stackId
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.
 


ips
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.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticIpsResult extends Object implements Serializable




Serialized Fields


elasticIps
com.amazonaws.internal.SdkInternalList<T> elasticIps

 An ElasticIps object that describes the specified Elastic IP
 addresses.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 A stack ID. The action describes the stack's Elastic Load Balancing
 instances.
 


layerIds
com.amazonaws.internal.SdkInternalList<T> layerIds

 A list of layer IDs. The action describes the Elastic Load Balancing
 instances for the specified layers.
 








Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersResult extends Object implements Serializable




Serialized Fields


elasticLoadBalancers
com.amazonaws.internal.SdkInternalList<T> elasticLoadBalancers

 A list of ElasticLoadBalancer objects that describe the
 specified Elastic Load Balancing instances.
 








Class com.amazonaws.services.opsworks.model.DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 A stack ID. If you use this parameter, DescribeInstances
 returns descriptions of the instances associated with the specified
 stack.
 


layerId
String layerId

 A layer ID. If you use this parameter, DescribeInstances
 returns descriptions of the instances associated with the specified
 layer.
 


instanceIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeInstancesResult extends Object implements Serializable




Serialized Fields


instances
com.amazonaws.internal.SdkInternalList<T> instances

 An array of Instance objects that describe the instances.
 








Class com.amazonaws.services.opsworks.model.DescribeLayersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


layerIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeLayersResult extends Object implements Serializable




Serialized Fields


layers
com.amazonaws.internal.SdkInternalList<T> layers

 An array of Layer objects that describe the layers.
 








Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


layerIds
com.amazonaws.internal.SdkInternalList<T> layerIds

 An array of layer IDs.
 








Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingResult extends Object implements Serializable




Serialized Fields


loadBasedAutoScalingConfigurations
com.amazonaws.internal.SdkInternalList<T> loadBasedAutoScalingConfigurations

 An array of LoadBasedAutoScalingConfiguration objects that
 describe each layer's configuration.
 








Class com.amazonaws.services.opsworks.model.DescribeMyUserProfileRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.opsworks.model.DescribeMyUserProfileResult extends Object implements Serializable




Serialized Fields


userProfile
SelfUserProfile userProfile

 A UserProfile object that describes the user's SSH
 information.
 








Class com.amazonaws.services.opsworks.model.DescribePermissionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.DescribePermissionsResult extends Object implements Serializable




Serialized Fields


permissions
com.amazonaws.internal.SdkInternalList<T> permissions

 An array of Permission objects that describe the stack
 permissions.
 
 
 If the request object contains only a stack ID, the array contains a
 Permission object with permissions for each of the stack IAM
 ARNs.
 If the request object contains only an IAM ARN, the array contains a
 Permission object with permissions for each of the user's
 stack IDs.
 If the request contains a stack ID and an IAM ARN, the array contains
 a single Permission object with permissions for the
 specified stack and IAM ARN.
 








Class com.amazonaws.services.opsworks.model.DescribeRaidArraysRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID. If you use this parameter,
 DescribeRaidArrays returns descriptions of the RAID arrays
 associated with the specified instance.
 


stackId
String stackId

 The stack ID.
 


raidArrayIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeRaidArraysResult extends Object implements Serializable




Serialized Fields


raidArrays
com.amazonaws.internal.SdkInternalList<T> raidArrays

 A RaidArrays object that describes the specified RAID
 arrays.
 








Class com.amazonaws.services.opsworks.model.DescribeRdsDbInstancesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID that the instances are registered with. The operation
 returns descriptions of all registered Amazon RDS instances.
 


rdsDbInstanceArns
com.amazonaws.internal.SdkInternalList<T> rdsDbInstanceArns

 An array containing the ARNs of the instances to be described.
 








Class com.amazonaws.services.opsworks.model.DescribeRdsDbInstancesResult extends Object implements Serializable




Serialized Fields


rdsDbInstances
com.amazonaws.internal.SdkInternalList<T> rdsDbInstances

 An a array of RdsDbInstance objects that describe the
 instances.
 








Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID. If you use this parameter,
 DescribeServiceErrors returns descriptions of the errors
 associated with the specified stack.
 


instanceId
String instanceId

 The instance ID. If you use this parameter,
 DescribeServiceErrors returns descriptions of the errors
 associated with the specified instance.
 


serviceErrorIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsResult extends Object implements Serializable




Serialized Fields


serviceErrors
com.amazonaws.internal.SdkInternalList<T> serviceErrors

 An array of ServiceError objects that describe the specified
 service errors.
 








Class com.amazonaws.services.opsworks.model.DescribeStackProvisioningParametersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID
 








Class com.amazonaws.services.opsworks.model.DescribeStackProvisioningParametersResult extends Object implements Serializable




Serialized Fields


agentInstallerUrl
String agentInstallerUrl

 The AWS OpsWorks agent installer's URL.
 


parameters
com.amazonaws.internal.SdkInternalMap<K,V> parameters

 An embedded object that contains the provisioning parameters.
 








Class com.amazonaws.services.opsworks.model.DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeStacksResult extends Object implements Serializable




Serialized Fields


stacks
com.amazonaws.internal.SdkInternalList<T> stacks

 An array of Stack objects that describe the stacks.
 








Class com.amazonaws.services.opsworks.model.DescribeStackSummaryRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.DescribeStackSummaryResult extends Object implements Serializable




Serialized Fields


stackSummary
StackSummary stackSummary

 A StackSummary object that contains the results.
 








Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceIds
com.amazonaws.internal.SdkInternalList<T> instanceIds

 An array of instance IDs.
 








Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingResult extends Object implements Serializable




Serialized Fields


timeBasedAutoScalingConfigurations
com.amazonaws.internal.SdkInternalList<T> timeBasedAutoScalingConfigurations

 An array of TimeBasedAutoScalingConfiguration objects that
 describe the configuration for the specified instances.
 








Class com.amazonaws.services.opsworks.model.DescribeUserProfilesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


iamUserArns
com.amazonaws.internal.SdkInternalList<T> iamUserArns

 An array of IAM user ARNs that identify the users to be described.
 








Class com.amazonaws.services.opsworks.model.DescribeUserProfilesResult extends Object implements Serializable




Serialized Fields


userProfiles
com.amazonaws.internal.SdkInternalList<T> userProfiles

 A Users object that describes the specified users.
 








Class com.amazonaws.services.opsworks.model.DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID. If you use this parameter, DescribeVolumes
 returns descriptions of the volumes associated with the specified
 instance.
 


stackId
String stackId

 A stack ID. The action describes the stack's registered Amazon EBS
 volumes.
 


raidArrayId
String raidArrayId

 The RAID array ID. If you use this parameter,
 DescribeVolumes returns descriptions of the volumes
 associated with the specified RAID array.
 


volumeIds
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.
 








Class com.amazonaws.services.opsworks.model.DescribeVolumesResult extends Object implements Serializable




Serialized Fields


volumes
com.amazonaws.internal.SdkInternalList<T> volumes

 An array of volume IDs.
 








Class com.amazonaws.services.opsworks.model.DetachElasticLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


elasticLoadBalancerName
String elasticLoadBalancerName

 The Elastic Load Balancing instance's name.
 


layerId
String layerId

 The ID of the layer that the Elastic Load Balancing instance is attached
 to.
 








Class com.amazonaws.services.opsworks.model.DisassociateElasticIpRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 








Class com.amazonaws.services.opsworks.model.EbsBlockDevice extends Object implements Serializable




Serialized Fields


snapshotId
String snapshotId

 The snapshot ID.
 


iops
Integer iops

 The number of I/O operations per second (IOPS) that the volume supports.
 For more information, see EbsBlockDevice.
 


volumeSize
Integer volumeSize

 The volume size, in GiB. For more information, see EbsBlockDevice.
 


volumeType
String volumeType

 The volume type. gp2 for General Purpose (SSD) volumes,
 io1 for Provisioned IOPS (SSD) volumes, and
 standard for Magnetic volumes.
 


deleteOnTermination
Boolean deleteOnTermination

 Whether the volume is deleted on instance termination.
 








Class com.amazonaws.services.opsworks.model.EcsCluster extends Object implements Serializable




Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's ARN.
 


ecsClusterName
String ecsClusterName

 The cluster name.
 


stackId
String stackId

 The stack ID.
 


registeredAt
String registeredAt

 The time and date that the cluster was registered with the stack.
 








Class com.amazonaws.services.opsworks.model.ElasticIp extends Object implements Serializable




Serialized Fields


ip
String ip

 The IP address.
 


name
String name

 The name.
 


domain
String domain

 The domain.
 


region
String region

 The AWS region. For more information, see Regions
 and Endpoints.
 


instanceId
String instanceId

 The ID of the instance that the address is attached to.
 








Class com.amazonaws.services.opsworks.model.ElasticLoadBalancer extends Object implements Serializable




Serialized Fields


elasticLoadBalancerName
String elasticLoadBalancerName

 The Elastic Load Balancing instance's name.
 


region
String region

 The instance's AWS region.
 


dnsName
String dnsName

 The instance's public DNS name.
 


stackId
String stackId

 The ID of the stack that the instance is associated with.
 


layerId
String layerId

 The ID of the layer that the instance is attached to.
 


vpcId
String vpcId

 The VPC ID.
 


availabilityZones
com.amazonaws.internal.SdkInternalList<T> availabilityZones

 A list of Availability Zones.
 


subnetIds
com.amazonaws.internal.SdkInternalList<T> subnetIds

 A list of subnet IDs, if the stack is running in a VPC.
 


ec2InstanceIds
com.amazonaws.internal.SdkInternalList<T> ec2InstanceIds

 A list of the EC2 instances that the Elastic Load Balancing instance is
 managing traffic for.
 








Class com.amazonaws.services.opsworks.model.EnvironmentVariable extends Object implements Serializable




Serialized Fields


key
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.
 


value
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.
 


secure
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.
 








Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


layerId
String layerId

 The layer ID.
 








Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionResult extends Object implements Serializable




Serialized Fields


layerId
String layerId

 The layer ID.
 


hostname
String hostname

 The generated host name.
 








Class com.amazonaws.services.opsworks.model.GrantAccessRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance's AWS OpsWorks ID.
 


validForInMinutes
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.
 








Class com.amazonaws.services.opsworks.model.GrantAccessResult extends Object implements Serializable




Serialized Fields


temporaryCredential
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.
 








Class com.amazonaws.services.opsworks.model.Instance extends Object implements Serializable




Serialized Fields


agentVersion
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.
 


amiId
String amiId

 A custom AMI ID to be used to create the instance. For more information,
 see Instances
 


architecture
String architecture

 The instance architecture: "i386" or "x86_64".
 


autoScalingType
String autoScalingType

 For load-based or time-based instances, the type.
 


availabilityZone
String availabilityZone

 The instance Availability Zone. For more information, see Regions
 and Endpoints.
 


blockDeviceMappings
com.amazonaws.internal.SdkInternalList<T> blockDeviceMappings

 An array of BlockDeviceMapping objects that specify the
 instance's block device mappings.
 


createdAt
String createdAt

 The time that the instance was created.
 


ebsOptimized
Boolean ebsOptimized

 Whether this is an Amazon EBS-optimized instance.
 


ec2InstanceId
String ec2InstanceId

 The ID of the associated Amazon EC2 instance.
 


ecsClusterArn
String ecsClusterArn

 For container instances, the Amazon ECS cluster's ARN.
 


ecsContainerInstanceArn
String ecsContainerInstanceArn

 For container instances, the instance's ARN.
 


elasticIp
String elasticIp

 The instance Elastic IP address .
 


hostname
String hostname

 The instance host name.
 


infrastructureClass
String infrastructureClass

 For registered instances, the infrastructure class: ec2 or
 on-premises.
 


installUpdatesOnBoot
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.
 
 


instanceId
String instanceId

 The instance ID.
 


instanceProfileArn
String instanceProfileArn

 The ARN of the instance's IAM profile. For more information about IAM
 ARNs, see Using Identifiers.
 


instanceType
String instanceType

 The instance type, such as t2.micro.
 


lastServiceErrorId
String lastServiceErrorId

 The ID of the last service error. For more information, call
 DescribeServiceErrors.
 


layerIds
com.amazonaws.internal.SdkInternalList<T> layerIds

 An array containing the instance layer IDs.
 


os
String os

 The instance's operating system.
 


platform
String platform

 The instance's platform.
 


privateDns
String privateDns

 The The instance's private DNS name.
 


privateIp
String privateIp

 The instance's private IP address.
 


publicDns
String publicDns

 The instance public DNS name.
 


publicIp
String publicIp

 The instance public IP address.
 


registeredBy
String registeredBy

 For registered instances, who performed the registration.
 


reportedAgentVersion
String reportedAgentVersion

 The instance's reported AWS OpsWorks agent version.
 


reportedOs
ReportedOs reportedOs

 For registered instances, the reported operating system.
 


rootDeviceType
String rootDeviceType

 The instance's root device type. For more information, see Storage for the Root Device.
 


rootDeviceVolumeId
String rootDeviceVolumeId

 The root device volume ID.
 


securityGroupIds
com.amazonaws.internal.SdkInternalList<T> securityGroupIds

 An array containing the instance security group IDs.
 


sshHostDsaKeyFingerprint
String sshHostDsaKeyFingerprint

 The SSH key's Deep Security Agent (DSA) fingerprint.
 


sshHostRsaKeyFingerprint
String sshHostRsaKeyFingerprint

 The SSH key's RSA fingerprint.
 


sshKeyName
String sshKeyName

 The instance's Amazon EC2 key-pair name.
 


stackId
String stackId

 The stack ID.
 


status
String status

 The instance status:
 
 
  booting
  connection_lost
  online
  pending
  rebooting
  requested
  running_setup
  setup_failed
  shutting_down
  start_failed
  stopped
  stopping
  terminated
  terminating
 


subnetId
String subnetId

 The instance's subnet ID; applicable only if the stack is running in a
 VPC.
 


virtualizationType
String virtualizationType

 The instance's virtualization type: paravirtual or
 hvm.
 








Class com.amazonaws.services.opsworks.model.InstanceIdentity extends Object implements Serializable




Serialized Fields


document
String document

 A JSON document that contains the metadata.
 


signature
String signature

 A signature that can be used to verify the document's accuracy and
 authenticity.
 








Class com.amazonaws.services.opsworks.model.InstancesCount extends Object implements Serializable




Serialized Fields


assigning
Integer assigning

 The number of instances in the Assigning state.
 


booting
Integer booting

 The number of instances with booting status.
 


connectionLost
Integer connectionLost

 The number of instances with connection_lost status.
 


deregistering
Integer deregistering

 The number of instances in the Deregistering state.
 


online
Integer online

 The number of instances with online status.
 


pending
Integer pending

 The number of instances with pending status.
 


rebooting
Integer rebooting

 The number of instances with rebooting status.
 


registered
Integer registered

 The number of instances in the Registered state.
 


registering
Integer registering

 The number of instances in the Registering state.
 


requested
Integer requested

 The number of instances with requested status.
 


runningSetup
Integer runningSetup

 The number of instances with running_setup status.
 


setupFailed
Integer setupFailed

 The number of instances with setup_failed status.
 


shuttingDown
Integer shuttingDown

 The number of instances with shutting_down status.
 


startFailed
Integer startFailed

 The number of instances with start_failed status.
 


stopped
Integer stopped

 The number of instances with stopped status.
 


stopping
Integer stopping

 The number of instances with stopping status.
 


terminated
Integer terminated

 The number of instances with terminated status.
 


terminating
Integer terminating

 The number of instances with terminating status.
 


unassigning
Integer unassigning

 The number of instances in the Unassigning state.
 








Class com.amazonaws.services.opsworks.model.Layer extends Object implements Serializable




Serialized Fields


stackId
String stackId

 The layer stack ID.
 


layerId
String layerId

 The layer ID.
 


type
String type

 The layer type.
 


name
String name

 The layer name.
 


shortname
String shortname

 The layer short name.
 


attributes
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.
 


customInstanceProfileArn
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.
 


customJson
String customJson

 A JSON formatted string containing the layer's custom stack configuration
 and deployment attributes.
 


customSecurityGroupIds
com.amazonaws.internal.SdkInternalList<T> customSecurityGroupIds

 An array containing the layer's custom security group IDs.
 


defaultSecurityGroupNames
com.amazonaws.internal.SdkInternalList<T> defaultSecurityGroupNames

 An array containing the layer's security group names.
 


packages
com.amazonaws.internal.SdkInternalList<T> packages

 An array of Package objects that describe the layer's
 packages.
 


volumeConfigurations
com.amazonaws.internal.SdkInternalList<T> volumeConfigurations

 A VolumeConfigurations object that describes the layer's
 Amazon EBS volumes.
 


enableAutoHealing
Boolean enableAutoHealing

 Whether auto healing is disabled for the layer.
 


autoAssignElasticIps
Boolean autoAssignElasticIps

 Whether to automatically assign an Elastic IP address to the layer's instances. For more information,
 see How to Edit a Layer.
 


autoAssignPublicIps
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.
 


defaultRecipes
Recipes defaultRecipes


customRecipes
Recipes customRecipes

 A LayerCustomRecipes object that specifies the layer's
 custom recipes.
 


createdAt
String createdAt

 Date when the layer was created.
 


installUpdatesOnBoot
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.
 
 


useEbsOptimizedInstances
Boolean useEbsOptimizedInstances

 Whether the layer uses Amazon EBS-optimized instances.
 


lifecycleEventConfiguration
LifecycleEventConfiguration lifecycleEventConfiguration

 A LifeCycleEventConfiguration object that specifies the
 Shutdown event configuration.
 








Class com.amazonaws.services.opsworks.model.LifecycleEventConfiguration extends Object implements Serializable




Serialized Fields


shutdown
ShutdownEventConfiguration shutdown

 A ShutdownEventConfiguration object that specifies the
 Shutdown event configuration.
 








Class com.amazonaws.services.opsworks.model.LoadBasedAutoScalingConfiguration extends Object implements Serializable




Serialized Fields


layerId
String layerId

 The layer ID.
 


enable
Boolean enable

 Whether load-based auto scaling is enabled for the layer.
 


upScaling
AutoScalingThresholds upScaling

 An AutoScalingThresholds object that describes the upscaling
 configuration, which defines how and when AWS OpsWorks increases the
 number of instances.
 


downScaling
AutoScalingThresholds downScaling

 An AutoScalingThresholds object that describes the
 downscaling configuration, which defines how and when AWS OpsWorks
 reduces the number of instances.
 








Class com.amazonaws.services.opsworks.model.Permission extends Object implements Serializable




Serialized Fields


stackId
String stackId

 A stack ID.
 


iamUserArn
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.
 


allowSsh
Boolean allowSsh

 Whether the user can use SSH.
 


allowSudo
Boolean allowSudo

 Whether the user can use sudo.
 


level
String level

 The user's permission level, which must be the following:
 
 
  deny
  show
  deploy
  manage
  iam_only
 
 
 For more information on the permissions associated with these levels, see
 Managing User Permissions
 








Class com.amazonaws.services.opsworks.model.RaidArray extends Object implements Serializable




Serialized Fields


raidArrayId
String raidArrayId

 The array ID.
 


instanceId
String instanceId

 The instance ID.
 


name
String name

 The array name.
 


raidLevel
Integer raidLevel

 The RAID
 level.
 


numberOfDisks
Integer numberOfDisks

 The number of disks in the array.
 


size
Integer size

 The array's size.
 


device
String device

 The array's Linux device. For example /dev/mdadm0.
 


mountPoint
String mountPoint

 The array's mount point.
 


availabilityZone
String availabilityZone

 The array's Availability Zone. For more information, see Regions
 and Endpoints.
 


createdAt
String createdAt

 When the RAID array was created.
 


stackId
String stackId

 The stack ID.
 


volumeType
String volumeType

 The volume type, standard or PIOPS.
 


iops
Integer iops

 For PIOPS volumes, the IOPS per disk.
 








Class com.amazonaws.services.opsworks.model.RdsDbInstance extends Object implements Serializable




Serialized Fields


rdsDbInstanceArn
String rdsDbInstanceArn

 The instance's ARN.
 


dbInstanceIdentifier
String dbInstanceIdentifier

 The DB instance identifier.
 


dbUser
String dbUser

 The master user name.
 


dbPassword
String dbPassword

 AWS OpsWorks returns *****FILTERED***** instead of the
 actual value.
 


region
String region

 The instance's AWS region.
 


address
String address

 The instance's address.
 


engine
String engine

 The instance's database engine.
 


stackId
String stackId

 The ID of the stack that the instance is registered with.
 


missingOnRds
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.
 








Class com.amazonaws.services.opsworks.model.RebootInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.Recipes extends Object implements Serializable




Serialized Fields


setup
com.amazonaws.internal.SdkInternalList<T> setup

 An array of custom recipe names to be run following a setup
 event.
 


configure
com.amazonaws.internal.SdkInternalList<T> configure

 An array of custom recipe names to be run following a
 configure event.
 


deploy
com.amazonaws.internal.SdkInternalList<T> deploy

 An array of custom recipe names to be run following a deploy
 event.
 


undeploy
com.amazonaws.internal.SdkInternalList<T> undeploy

 An array of custom recipe names to be run following a
 undeploy event.
 


shutdown
com.amazonaws.internal.SdkInternalList<T> shutdown

 An array of custom recipe names to be run following a
 shutdown event.
 








Class com.amazonaws.services.opsworks.model.RegisterEcsClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's ARN.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.RegisterEcsClusterResult extends Object implements Serializable




Serialized Fields


ecsClusterArn
String ecsClusterArn

 The cluster's ARN.
 








Class com.amazonaws.services.opsworks.model.RegisterElasticIpRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.RegisterElasticIpResult extends Object implements Serializable




Serialized Fields


elasticIp
String elasticIp

 The Elastic IP address.
 








Class com.amazonaws.services.opsworks.model.RegisterInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The ID of the stack that the instance is to be registered with.
 


hostname
String hostname

 The instance's hostname.
 


publicIp
String publicIp

 The instance's public IP address.
 


privateIp
String privateIp

 The instance's private IP address.
 


rsaPublicKey
String rsaPublicKey

 The instances public RSA key. This key is used to encrypt communication
 between the instance and the service.
 


rsaPublicKeyFingerprint
String rsaPublicKeyFingerprint

 The instances public RSA key fingerprint.
 


instanceIdentity
InstanceIdentity instanceIdentity

 An InstanceIdentity object that contains the instance's identity.
 








Class com.amazonaws.services.opsworks.model.RegisterInstanceResult extends Object implements Serializable




Serialized Fields


instanceId
String instanceId

 The registered instance's AWS OpsWorks ID.
 








Class com.amazonaws.services.opsworks.model.RegisterRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


rdsDbInstanceArn
String rdsDbInstanceArn

 The Amazon RDS instance's ARN.
 


dbUser
String dbUser

 The database's master user name.
 


dbPassword
String dbPassword

 The database password.
 








Class com.amazonaws.services.opsworks.model.RegisterVolumeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


ec2VolumeId
String ec2VolumeId

 The Amazon EBS volume ID.
 


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.RegisterVolumeResult extends Object implements Serializable




Serialized Fields


volumeId
String volumeId

 The volume ID.
 








Class com.amazonaws.services.opsworks.model.ReportedOs extends Object implements Serializable




Serialized Fields


family
String family

 The operating system family.
 


name
String name

 The operating system name.
 


version
String version

 The operating system version.
 








Class com.amazonaws.services.opsworks.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworks.model.SelfUserProfile extends Object implements Serializable




Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


name
String name

 The user's name.
 


sshUsername
String sshUsername

 The user's SSH user name.
 


sshPublicKey
String sshPublicKey

 The user's SSH public key.
 








Class com.amazonaws.services.opsworks.model.ServiceError extends Object implements Serializable




Serialized Fields


serviceErrorId
String serviceErrorId

 The error ID.
 


stackId
String stackId

 The stack ID.
 


instanceId
String instanceId

 The instance ID.
 


type
String type

 The error type.
 


message
String message

 A message that describes the error.
 


createdAt
String createdAt

 When the error occurred.
 








Class com.amazonaws.services.opsworks.model.SetLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


layerId
String layerId

 The layer ID.
 


enable
Boolean enable

 Enables load-based auto scaling for the layer.
 


upScaling
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.
 


downScaling
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.
 








Class com.amazonaws.services.opsworks.model.SetPermissionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


allowSsh
Boolean allowSsh

 The user is allowed to use SSH to communicate with the instance.
 


allowSudo
Boolean allowSudo

 The user is allowed to use sudo to elevate privileges.
 


level
String level

 The user's permission level, which must be set to one of the following
 strings. You cannot set your own permissions level.
 
 
  deny
  show
  deploy
  manage
  iam_only
 
 
 For more information on the permissions associated with these levels, see
 Managing User Permissions.
 








Class com.amazonaws.services.opsworks.model.SetTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 


autoScalingSchedule
WeeklyAutoScalingSchedule autoScalingSchedule

 An AutoScalingSchedule with the instance schedule.
 








Class com.amazonaws.services.opsworks.model.ShutdownEventConfiguration extends Object implements Serializable




Serialized Fields


executionTimeout
Integer executionTimeout

 The time, in seconds, that AWS OpsWorks will wait after triggering a
 Shutdown event before shutting down an instance.
 


delayUntilElbConnectionsDrained
Boolean delayUntilElbConnectionsDrained

 Whether to enable Elastic Load Balancing connection draining. For more
 information, see Connection Draining
 








Class com.amazonaws.services.opsworks.model.Source extends Object implements Serializable




Serialized Fields


type
String type

 The repository type.
 


url
String url

 The source URL.
 


username
String username

 This parameter depends on the repository type.
 
 
 For Amazon S3 bundles, set Username to the appropriate
 IAM access key ID.
 For HTTP bundles, Git repositories, and Subversion repositories, set
 Username to the user name.
 


password
String password

 When included in a request, the parameter depends on the repository type.
 
 
 For Amazon S3 bundles, set Password to the appropriate
 IAM secret access key.
 For HTTP bundles and Subversion repositories, set
 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.
 



sshKey
String sshKey

 In requests, the repository's SSH key.
 
 
 In responses, AWS OpsWorks returns *****FILTERED*****
 instead of the actual value.
 


revision
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.
 








Class com.amazonaws.services.opsworks.model.SslConfiguration extends Object implements Serializable




Serialized Fields


certificate
String certificate

 The contents of the certificate's domain.crt file.
 


privateKey
String privateKey

 The private key; the contents of the certificate's domain.kex file.
 


chain
String chain

 Optional. Can be used to specify an intermediate certificate authority
 key or client authentication.
 








Class com.amazonaws.services.opsworks.model.Stack extends Object implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


name
String name

 The stack name.
 


arn
String arn

 The stack's ARN.
 


region
String region

 The stack AWS region, such as "us-east-1". For more information about AWS
 regions, see Regions
 and Endpoints.
 


vpcId
String vpcId

 The VPC ID; applicable only if the stack is running in a VPC.
 


attributes
com.amazonaws.internal.SdkInternalMap<K,V> attributes

 The stack's attributes.
 


serviceRoleArn
String serviceRoleArn

 The stack AWS Identity and Access Management (IAM) role.
 


defaultInstanceProfileArn
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.
 


defaultOs
String defaultOs

 The stack's default operating system.
 


hostnameTheme
String hostnameTheme

 The stack host name theme, with spaces replaced by underscores.
 


defaultAvailabilityZone
String defaultAvailabilityZone

 The stack's default Availability Zone. For more information, see Regions
 and Endpoints.
 


defaultSubnetId
String defaultSubnetId

 The default subnet ID; applicable only if the stack is running in a VPC.
 


customJson
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.
 


configurationManager
StackConfigurationManager configurationManager

 The configuration manager.
 


chefConfiguration
ChefConfiguration chefConfiguration

 A ChefConfiguration object that specifies whether to enable
 Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether the stack uses custom cookbooks.
 


useOpsworksSecurityGroups
Boolean useOpsworksSecurityGroups

 Whether the stack automatically associates the AWS OpsWorks built-in
 security groups with the stack's layers.
 


customCookbooksSource
Source customCookbooksSource


defaultSshKeyName
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.
 


createdAt
String createdAt

 The date when the stack was created.
 


defaultRootDeviceType
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.
 


agentVersion
String agentVersion

 The agent version. This parameter is set to LATEST for
 auto-update. or a version number for a fixed agent version.
 








Class com.amazonaws.services.opsworks.model.StackConfigurationManager extends Object implements Serializable




Serialized Fields


name
String name

 The name. This parameter must be set to "Chef".
 


version
String version

 The Chef version. This parameter must be set to 12, 11.10, or 11.4 for
 Linux stacks, and to 12.2 for Windows stacks. The default value for Linux
 stacks is 11.4.
 








Class com.amazonaws.services.opsworks.model.StackSummary extends Object implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


name
String name

 The stack name.
 


arn
String arn

 The stack's ARN.
 


layersCount
Integer layersCount

 The number of layers.
 


appsCount
Integer appsCount

 The number of apps.
 


instancesCount
InstancesCount instancesCount

 An InstancesCount object with the number of instances in
 each status.
 








Class com.amazonaws.services.opsworks.model.StartInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.StartStackRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.StopInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.StopStackRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 








Class com.amazonaws.services.opsworks.model.TemporaryCredential extends Object implements Serializable




Serialized Fields


username
String username

 The user name.
 


password
String password

 The password.
 


validForInMinutes
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.
 


instanceId
String instanceId

 The instance's AWS OpsWorks ID.
 








Class com.amazonaws.services.opsworks.model.TimeBasedAutoScalingConfiguration extends Object implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 


autoScalingSchedule
WeeklyAutoScalingSchedule autoScalingSchedule

 A WeeklyAutoScalingSchedule object with the instance
 schedule.
 








Class com.amazonaws.services.opsworks.model.UnassignInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 








Class com.amazonaws.services.opsworks.model.UnassignVolumeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


volumeId
String volumeId

 The volume ID.
 








Class com.amazonaws.services.opsworks.model.UpdateAppRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


appId
String appId

 The app ID.
 


name
String name

 The app name.
 


description
String description

 A description of the app.
 


dataSources
com.amazonaws.internal.SdkInternalList<T> dataSources

 The app's data sources.
 


type
String type

 The app type.
 


appSource
Source appSource

 A Source object that specifies the app repository.
 


domains
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'
 


enableSsl
Boolean enableSsl

 Whether SSL is enabled for the app.
 


sslConfiguration
SslConfiguration sslConfiguration

 An SslConfiguration object with the SSL configuration.
 


attributes
com.amazonaws.internal.SdkInternalMap<K,V> attributes

 One or more user-defined key/value pairs to be added to the stack
 attributes.
 


environment
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)."
 
 This parameter is supported only by Chef 11.10 stacks. If you have
 specified one or more environment variables, you cannot modify the
 stack's Chef version. 








Class com.amazonaws.services.opsworks.model.UpdateElasticIpRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


elasticIp
String elasticIp

 The address.
 


name
String name

 The new name.
 








Class com.amazonaws.services.opsworks.model.UpdateInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


instanceId
String instanceId

 The instance ID.
 


layerIds
com.amazonaws.internal.SdkInternalList<T> layerIds

 The instance's layer IDs.
 


instanceType
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.
 


autoScalingType
String autoScalingType

 For load-based or time-based instances, the type. Windows stacks can use
 only time-based instances.
 


hostname
String hostname

 The instance host name.
 


os
String os

 The instance's operating system, which must be set to one of the
 following.
 
 
 A supported Linux operating system: An Amazon Linux version, such as
 Amazon Linux 2015.03,
 Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
 or Ubuntu 14.04 LTS.
 Microsoft Windows Server 2012 R2 Base.
 A custom AMI: 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.
 
 You can specify a different Linux operating system for the updated
 stack, but you cannot change from Linux to Windows or Windows to
 Linux.


amiId
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
 
 If you specify a custom AMI, you must set Os to
 Custom.


sshKeyName
String sshKeyName

 The instance's Amazon EC2 key name.
 


architecture
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.
 


installUpdatesOnBoot
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.
 
 


ebsOptimized
Boolean ebsOptimized

 This property cannot be updated.
 


agentVersion
String agentVersion

 The default AWS OpsWorks agent version. You have the following options:
 
 
 INHERIT - Use the stack's default agent version setting.
 
 version_number - Use the specified agent version. This value
 overrides the stack's default setting. To update the agent version, you
 must edit the instance configuration and specify a new version. AWS
 OpsWorks then automatically installs that version on the instance.
 
 
 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.
 








Class com.amazonaws.services.opsworks.model.UpdateLayerRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


layerId
String layerId

 The layer ID.
 


name
String name

 The layer name, which is used by the console.
 


shortname
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
 


attributes
com.amazonaws.internal.SdkInternalMap<K,V> attributes

 One or more user-defined key/value pairs to be added to the stack
 attributes.
 


customInstanceProfileArn
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.
 


customJson
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.
 


customSecurityGroupIds
com.amazonaws.internal.SdkInternalList<T> customSecurityGroupIds

 An array containing the layer's custom security group IDs.
 


packages
com.amazonaws.internal.SdkInternalList<T> packages

 An array of Package objects that describe the layer's
 packages.
 


volumeConfigurations
com.amazonaws.internal.SdkInternalList<T> volumeConfigurations

 A VolumeConfigurations object that describes the layer's
 Amazon EBS volumes.
 


enableAutoHealing
Boolean enableAutoHealing

 Whether to disable auto healing for the layer.
 


autoAssignElasticIps
Boolean autoAssignElasticIps

 Whether to automatically assign an Elastic IP address to the layer's instances. For more information,
 see How to Edit a Layer.
 


autoAssignPublicIps
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.
 


customRecipes
Recipes customRecipes

 A LayerCustomRecipes object that specifies the layer's
 custom recipes.
 


installUpdatesOnBoot
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.
 
 


useEbsOptimizedInstances
Boolean useEbsOptimizedInstances

 Whether to use Amazon EBS-optimized instances.
 


lifecycleEventConfiguration
LifecycleEventConfiguration lifecycleEventConfiguration









Class com.amazonaws.services.opsworks.model.UpdateMyUserProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sshPublicKey
String sshPublicKey

 The user's SSH public key.
 








Class com.amazonaws.services.opsworks.model.UpdateRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


rdsDbInstanceArn
String rdsDbInstanceArn

 The Amazon RDS instance's ARN.
 


dbUser
String dbUser

 The master user name.
 


dbPassword
String dbPassword

 The database password.
 








Class com.amazonaws.services.opsworks.model.UpdateStackRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


stackId
String stackId

 The stack ID.
 


name
String name

 The stack's new name.
 


attributes
com.amazonaws.internal.SdkInternalMap<K,V> attributes

 One or more user-defined key-value pairs to be added to the stack
 attributes.
 


serviceRoleArn
String serviceRoleArn

 Do not use this parameter. You cannot update a stack's service role.
 


defaultInstanceProfileArn
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.
 


defaultOs
String defaultOs

 The stack's operating system, which must be set to one of the following:
 
 
 A supported Linux operating system: An Amazon Linux version, such as
 Amazon Linux 2015.03,
 Red Hat Enterprise Linux 7, Ubuntu 12.04 LTS,
 or Ubuntu 14.04 LTS.
 Microsoft Windows Server 2012 R2 Base.
 A custom AMI: 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.
 


hostnameTheme
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_Goods
  Clouds
  Europe_Cities
  Fruits
  Greek_Deities
  Legendary_creatures_from_Japan
  Planets_and_Moons
  Roman_Deities
  Scottish_Islands
  US_Cities
  Wild_Cats
 
 
 To obtain a generated host name, call GetHostNameSuggestion,
 which returns a host name based on the current theme.
 


defaultAvailabilityZone
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.
 


defaultSubnetId
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.
 


customJson
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.
 


configurationManager
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 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.
 


useCustomCookbooks
Boolean useCustomCookbooks

 Whether the stack uses custom cookbooks.
 


customCookbooksSource
Source customCookbooksSource


defaultSshKeyName
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.
 


defaultRootDeviceType
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.
 


useOpsworksSecurityGroups
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:
 
 
 True - AWS OpsWorks automatically associates the appropriate built-in
 security group with each layer (default setting). You can associate
 additional security groups with a layer after you create it, but you
 cannot delete the built-in security group.
 False - AWS OpsWorks does not associate built-in security groups with
 layers. You must create appropriate EC2 security groups and associate a
 security group with each layer that you create. However, you can still
 manually associate a built-in security group with a layer on. Custom
 security groups are required only for those layers that need custom
 settings.
 
 
 For more information, see Create a New Stack.
 


agentVersion
String agentVersion

 The default AWS OpsWorks agent version. You have the following options:
 
 
 Auto-update - Set this parameter to LATEST. AWS OpsWorks
 automatically installs new agent versions on the stack's instances as
 soon as they are available.
 Fixed version - Set this parameter to your preferred agent version.
 To update the agent version, you must edit the stack configuration and
 specify a new version. AWS OpsWorks then automatically installs that
 version on the stack's instances.
 
 
 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.
 
 You can also specify an agent version when you create or update an
 instance, which overrides the stack's default setting.








Class com.amazonaws.services.opsworks.model.UpdateUserProfileRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


iamUserArn
String iamUserArn

 The user IAM ARN.
 


sshUsername
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.
 


sshPublicKey
String sshPublicKey

 The user's new SSH public key.
 


allowSelfManagement
Boolean allowSelfManagement

 Whether users can specify their own SSH public key through the My
 Settings page. For more information, see Managing User Permissions.
 








Class com.amazonaws.services.opsworks.model.UpdateVolumeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


volumeId
String volumeId

 The volume ID.
 


name
String name

 The new name.
 


mountPoint
String mountPoint

 The new mount point.
 








Class com.amazonaws.services.opsworks.model.UserProfile extends Object implements Serializable




Serialized Fields


iamUserArn
String iamUserArn

 The user's IAM ARN.
 


name
String name

 The user's name.
 


sshUsername
String sshUsername

 The user's SSH user name.
 


sshPublicKey
String sshPublicKey

 The user's SSH public key.
 


allowSelfManagement
Boolean allowSelfManagement

 Whether users can specify their own SSH public key through the My
 Settings page. For more information, see Managing User Permissions.
 








Class com.amazonaws.services.opsworks.model.ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.opsworks.model.Volume extends Object implements Serializable




Serialized Fields


volumeId
String volumeId

 The volume ID.
 


ec2VolumeId
String ec2VolumeId

 The Amazon EC2 volume ID.
 


name
String name

 The volume name.
 


raidArrayId
String raidArrayId

 The RAID array ID.
 


instanceId
String instanceId

 The instance ID.
 


status
String status

 The value returned by DescribeVolumes.
 


size
Integer size

 The volume size.
 


device
String device

 The device name.
 


mountPoint
String mountPoint

 The volume mount point. For example "/dev/sdh".
 


region
String region

 The AWS region. For more information about AWS regions, see Regions
 and Endpoints.
 


availabilityZone
String availabilityZone

 The volume Availability Zone. For more information, see Regions
 and Endpoints.
 


volumeType
String volumeType

 The volume type, standard or PIOPS.
 


iops
Integer iops

 For PIOPS volumes, the IOPS per disk.
 








Class com.amazonaws.services.opsworks.model.VolumeConfiguration extends Object implements Serializable




Serialized Fields


mountPoint
String mountPoint

 The volume mount point. For example "/dev/sdh".
 


raidLevel
Integer raidLevel

 The volume RAID level.
 


numberOfDisks
Integer numberOfDisks

 The number of disks in the volume.
 


size
Integer size

 The volume size.
 


volumeType
String volumeType

 The volume type:
 
 
 standard - Magnetic
 io1 - Provisioned IOPS (SSD)
 gp2 - General Purpose (SSD)
 


iops
Integer iops

 For PIOPS volumes, the IOPS per disk.
 








Class com.amazonaws.services.opsworks.model.WeeklyAutoScalingSchedule extends Object implements Serializable




Serialized Fields


monday
com.amazonaws.internal.SdkInternalMap<K,V> monday

 The schedule for Monday.
 


tuesday
com.amazonaws.internal.SdkInternalMap<K,V> tuesday

 The schedule for Tuesday.
 


wednesday
com.amazonaws.internal.SdkInternalMap<K,V> wednesday

 The schedule for Wednesday.
 


thursday
com.amazonaws.internal.SdkInternalMap<K,V> thursday

 The schedule for Thursday.
 


friday
com.amazonaws.internal.SdkInternalMap<K,V> friday

 The schedule for Friday.
 


saturday
com.amazonaws.internal.SdkInternalMap<K,V> saturday

 The schedule for Saturday.
 


sunday
com.amazonaws.internal.SdkInternalMap<K,V> sunday

 The schedule for Sunday.
 








Package com.amazonaws.services.rds.model




Class com.amazonaws.services.rds.model.AccountQuota extends Object implements Serializable




Serialized Fields


accountQuotaName
String accountQuotaName
The name of the Amazon RDS quota for this AWS account.


used
Long used
The amount currently used toward the quota maximum.


max
Long max
The maximum allowed value for the quota.








Class com.amazonaws.services.rds.model.AddSourceIdentifierToSubscriptionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


subscriptionName
String subscriptionName
The name of the RDS event notification subscription you want to add a
 source identifier to.


sourceIdentifier
String sourceIdentifier
The identifier of the event source to be added. An identifier must
 begin with a letter and must contain only ASCII letters, digits, and
 hyphens; it cannot end with a hyphen or contain two consecutive
 hyphens. Constraints: 
 If the source type is a DB instance,
 then a DBInstanceIdentifier must be supplied.
 If
 the source type is a DB security group, a
 DBSecurityGroupName must be supplied.
 If the
 source type is a DB parameter group, a
 DBParameterGroupName must be supplied.
 If the
 source type is a DB snapshot, a DBSnapshotIdentifier must
 be supplied.
 








Class com.amazonaws.services.rds.model.AddTagsToResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceName
String resourceName
The Amazon RDS resource the tags will be added to. This value is an
 Amazon Resource Name (ARN). For information about creating an ARN, see
 
 Constructing an RDS Amazon Resource Name (ARN).


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
The tags to be assigned to the Amazon RDS resource.








Class com.amazonaws.services.rds.model.ApplyPendingMaintenanceActionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceIdentifier
String resourceIdentifier
The RDS Amazon Resource Name (ARN) of the resource that the pending
 maintenance action applies to. For information about creating an ARN,
 see 
 Constructing an RDS Amazon Resource Name (ARN).


applyAction
String applyAction
The pending maintenance action to apply to this resource. Valid
 values: system-update, db-upgrade


optInType
String optInType
A value that specifies the type of opt-in request, or undoes an opt-in
 request. An opt-in request of type 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.
 








Class com.amazonaws.services.rds.model.AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.AuthorizationNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.AuthorizationQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.AuthorizeDBSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSecurityGroupName
String dBSecurityGroupName
The name of the DB security group to add authorization to.


cIDRIP
String cIDRIP
The IP range to authorize.


eC2SecurityGroupName
String eC2SecurityGroupName
Name of the EC2 security group to authorize. For VPC DB security
 groups, EC2SecurityGroupId must be provided. Otherwise,
 EC2SecurityGroupOwnerId and either
 EC2SecurityGroupName or EC2SecurityGroupId
 must be provided.


eC2SecurityGroupId
String eC2SecurityGroupId
Id of the EC2 security group to authorize. For VPC DB security groups,
 EC2SecurityGroupId must be provided. Otherwise,
 EC2SecurityGroupOwnerId and either
 EC2SecurityGroupName or EC2SecurityGroupId
 must be provided.


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId
AWS account number of the owner of the EC2 security group specified in
 the 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.








Class com.amazonaws.services.rds.model.AvailabilityZone extends Object implements Serializable




Serialized Fields


name
String name
The name of the availability zone.








Class com.amazonaws.services.rds.model.Certificate extends Object implements Serializable




Serialized Fields


certificateIdentifier
String certificateIdentifier
The unique key that identifies a certificate.


certificateType
String certificateType
The type of the certificate.


thumbprint
String thumbprint
The thumbprint of the certificate.


validFrom
Date validFrom
The starting date from which the certificate is valid.


validTill
Date validTill
The final date that the certificate continues to be valid.








Class com.amazonaws.services.rds.model.CertificateNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.CharacterSet extends Object implements Serializable




Serialized Fields


characterSetName
String characterSetName
The name of the character set.


characterSetDescription
String characterSetDescription
The description of the character set.








Class com.amazonaws.services.rds.model.CopyDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceDBClusterSnapshotIdentifier
String sourceDBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to copy. This parameter is
 not case-sensitive. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens.
 First character must be a
 letter.
 Cannot end with a hyphen or contain two consecutive
 hyphens.
 
 Example: my-cluster-snapshot1


targetDBClusterSnapshotIdentifier
String targetDBClusterSnapshotIdentifier
The identifier of the new DB cluster snapshot to create from the
 source DB cluster snapshot. This parameter is not case-sensitive.
 Constraints: 
 Must contain from 1 to 63 alphanumeric
 characters or hyphens.
 First character must be a letter.
 Cannot end with a hyphen or contain two consecutive hyphens.
 
 Example: my-cluster-snapshot2


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CopyDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceDBParameterGroupIdentifier
String sourceDBParameterGroupIdentifier
The identifier or ARN for the source DB parameter group. For
 information about creating an ARN, see 
 Constructing an RDS Amazon Resource Name (ARN). Constraints:
 
 Must specify a valid DB parameter group.
 If the
 source DB parameter group is in the same region as the copy, specify a
 valid DB parameter group identifier, for example
 my-db-param-group, or a valid ARN.
 If the source
 DB parameter group is in a different region than the copy, specify a
 valid DB parameter group ARN, for example
 arn:aws:rds:us-west-2:123456789012:pg:special-parameters.
 


targetDBParameterGroupIdentifier
String targetDBParameterGroupIdentifier
The identifier for the copied DB parameter group. Constraints: 

 Cannot be null, empty, or blank
 Must contain from 1 to
 255 alphanumeric characters or hyphens
 First character must
 be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 
 Example:
 my-db-parameter-group


targetDBParameterGroupDescription
String targetDBParameterGroupDescription
A description for the copied DB parameter group.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CopyDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceDBSnapshotIdentifier
String sourceDBSnapshotIdentifier
The identifier for the source DB snapshot. If you are copying from
 a shared manual DB snapshot, this must be the ARN of the shared DB
 snapshot. 
Constraints: 
 Must specify a valid system
 snapshot in the "available" state.
 If the source snapshot is
 in the same region as the copy, specify a valid DB snapshot
 identifier.
 If the source snapshot is in a different region
 than the copy, specify a valid DB snapshot ARN. For more information,
 go to 
 Copying a DB Snapshot.
 
 Example:
 rds:mydb-2012-04-02-00-01 
Example:
 arn:aws:rds:rr-regn-1:123456789012:snapshot:mysql-instance1-snapshot-20130805


targetDBSnapshotIdentifier
String targetDBSnapshotIdentifier
The identifier for the copied snapshot. Constraints: 

 Cannot be null, empty, or blank
 Must contain from 1 to
 255 alphanumeric characters or hyphens
 First character must
 be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 
 Example: my-db-snapshot


kmsKeyId
String kmsKeyId
The AWS Key Management Service (AWS KMS) key identifier for an
 encrypted DB snapshot. The KMS key identifier is the Amazon Resource
 Name (ARN) or the KMS key alias for the KMS encryption key. If you
 copy an unencrypted DB snapshot and specify a value for the
 KmsKeyId parameter, Amazon RDS encrypts the target DB
 snapshot using the specified KMS encryption key. 
If you copy an
 encrypted DB snapshot from your AWS account, you can specify a value
 for KmsKeyId to encrypt the copy with a new KMS
 encryption key. If you don't specify a value for KmsKeyId
 then the copy of the DB snapshot is encrypted with the same KMS key as
 the source DB snapshot. 
If you copy an encrypted DB snapshot that
 is shared from another AWS account, then you must specify a value for
 KmsKeyId.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.


copyTags
Boolean copyTags
True to copy all tags from the source DB snapshot to the target DB
 snapshot; otherwise false. The default is false.








Class com.amazonaws.services.rds.model.CopyOptionGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceOptionGroupIdentifier
String sourceOptionGroupIdentifier
The identifier or ARN for the source option group. For information
 about creating an ARN, see 
 Constructing an RDS Amazon Resource Name (ARN). Constraints:
 
 Must specify a valid option group.
 If the source
 option group is in the same region as the copy, specify a valid option
 group identifier, for example my-option-group, or a valid
 ARN.
 If the source option group is in a different region than
 the copy, specify a valid option group ARN, for example
 arn:aws:rds:us-west-2:123456789012:og:special-options.
 


targetOptionGroupIdentifier
String targetOptionGroupIdentifier
The identifier for the copied option group. Constraints: 

 Cannot be null, empty, or blank
 Must contain from 1 to
 255 alphanumeric characters or hyphens
 First character must
 be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 
 Example:
 my-option-group


targetOptionGroupDescription
String targetOptionGroupDescription
The description for the copied option group.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CreateDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group.  Constraints: 

 Must be 1 to 255 alphanumeric characters
 First character
 must be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 
 This value is stored as a
 lowercase string.


dBParameterGroupFamily
String dBParameterGroupFamily
The DB cluster parameter group family name. A DB cluster parameter
 group can be associated with one and only one DB cluster parameter
 group family, and can be applied only to a DB cluster running a
 database engine and engine version compatible with that DB cluster
 parameter group family.


description
String description
The description for the DB cluster parameter group.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CreateDBClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
A list of EC2 Availability Zones that instances in the DB cluster can
 be created in. For information on regions and Availability Zones, see
 Regions
 and Availability Zones.


backupRetentionPeriod
Integer backupRetentionPeriod
The number of days for which automated backups are retained. You must
 specify a minimum value of 1. Default: 1 
Constraints: 

 Must be a value from 1 to 35
 


characterSetName
String characterSetName
A value that indicates that the DB cluster should be associated with
 the specified CharacterSet.


databaseName
String databaseName
The name for your database of up to 8 alpha-numeric characters. If you
 do not provide a name, Amazon RDS will not create a database in the DB
 cluster you are creating.


dBClusterIdentifier
String dBClusterIdentifier
The DB cluster identifier. This parameter is stored as a lowercase
 string. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens.
 First character must be a
 letter.
 Cannot end with a hyphen or contain two consecutive
 hyphens.
 
 Example: my-cluster1


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group to associate with this DB
 cluster. If this argument is omitted, default.aurora5.6
 for the specified engine will be used.  Constraints: 
 Must
 be 1 to 255 alphanumeric characters
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 


vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB cluster.


dBSubnetGroupName
String dBSubnetGroupName
A DB subnet group to associate with this DB cluster. Constraints:
 Must contain no more than 255 alphanumeric characters, periods,
 underscores, spaces, or hyphens. Must not be default. 
Example:
 mySubnetgroup


engine
String engine
The name of the database engine to be used for this DB cluster.
 Valid Values: aurora


engineVersion
String engineVersion
The version number of the database engine to use.  Aurora
 
Example: 5.6.10a


port
Integer port
The port number on which the instances in the DB cluster accept
 connections.  Default: 3306


masterUsername
String masterUsername
The name of the master user for the client DB cluster. Constraints:
 
 Must be 1 to 16 alphanumeric characters.
 First
 character must be a letter.
 Cannot be a reserved word for the
 chosen database engine.
 


masterUserPassword
String masterUserPassword
The password for the master database user. This password can contain
 any printable ASCII character except "/", """, or "@". Constraints:
 Must contain from 8 to 41 characters.


optionGroupName
String optionGroupName
A value that indicates that the DB cluster should be associated with
 the specified option group. 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.


preferredBackupWindow
String preferredBackupWindow
The daily time range during which automated backups are created if
 automated backups are enabled using the
 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: 
 Must be in the format
 hh24:mi-hh24:mi.
 Times should be in Universal
 Coordinated Time (UTC).
 Must not conflict with the preferred
 maintenance window.
 Must be at least 30 minutes.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in
 Universal Coordinated Time (UTC).  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.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.


storageEncrypted
Boolean storageEncrypted
Specifies whether the DB cluster is encrypted.


kmsKeyId
String kmsKeyId
The KMS key identifier for an encrypted DB cluster. 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.








Class com.amazonaws.services.rds.model.CreateDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot. This parameter is stored as
 a lowercase string. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens.
 First character must be a
 letter.
 Cannot end with a hyphen or contain two consecutive
 hyphens.
 
 Example: my-cluster1-snapshot1


dBClusterIdentifier
String dBClusterIdentifier
The identifier of the DB cluster to create a snapshot for. This
 parameter is not case-sensitive. Constraints: 
 Must contain
 from 1 to 63 alphanumeric characters or hyphens.
 First
 character must be a letter.
 Cannot end with a hyphen or
 contain two consecutive hyphens.
 
 Example:
 my-cluster1


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
The tags to be assigned to the DB cluster snapshot.








Class com.amazonaws.services.rds.model.CreateDBInstanceReadReplicaRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The DB instance identifier of the Read Replica. This identifier is the
 unique key that identifies a DB instance. This parameter is stored as
 a lowercase string.


sourceDBInstanceIdentifier
String sourceDBInstanceIdentifier
The identifier of the DB instance that will act as the source for the
 Read Replica. Each DB instance can have up to five Read Replicas.
 Constraints: 
 Must be the identifier of an existing MySQL,
 MariaDB, or PostgreSQL DB instance.
 Can specify a DB instance
 that is a MySQL Read Replica only if the source is running MySQL
 5.6.
 Can specify a DB instance that is a PostgreSQL Read
 Replica only if the source is running PostgreSQL 9.3.5.
 The
 specified DB instance must have automatic backups enabled, its backup
 retention period must be greater than 0.
 If the source DB
 instance is in the same region as the Read Replica, specify a valid DB
 instance identifier.
 If the source DB instance is in a
 different region than the Read Replica, specify a valid DB instance
 ARN. For more information, go to 
 Constructing a Amazon RDS Amazon Resource Name (ARN).
 


dBInstanceClass
String dBInstanceClass
The compute and memory capacity of the Read Replica.  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.


availabilityZone
String availabilityZone
The Amazon EC2 Availability Zone that the Read Replica will be created
 in.  Default: A random, system-chosen Availability Zone in the
 endpoint's region. 
 Example: us-east-1d


port
Integer port
The port number that the DB instance uses for connections. Default:
 Inherits from the source DB instance 
Valid Values:
 1150-65535


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
Indicates that minor engine upgrades will be applied automatically to
 the Read Replica during the maintenance window. Default: Inherits
 from the source DB instance


iops
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to
 be initially allocated for the DB instance.


optionGroupName
String optionGroupName
The option group the DB instance will be associated with. If omitted,
 the default option group for the engine specified will be used.


publiclyAccessible
Boolean publiclyAccessible
Specifies the accessibility options for the DB instance. A value of
 true specifies an Internet-facing instance with a publicly resolvable
 DNS name, which resolves to a public IP address. A value of false
 specifies an internal instance with a DNS name that resolves to a
 private IP address.  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. 
  Default
 VPC:true
  VPC:false
 
  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.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.


dBSubnetGroupName
String dBSubnetGroupName
Specifies a DB subnet group for the DB instance. The new DB instance
 will be created in the VPC associated with the DB subnet group. If no
 DB subnet group is specified, then the new DB instance is not created
 in a VPC. Constraints: 
 Can only be specified if the source
 DB instance identifier specifies a DB instance in another region.
 The specified DB subnet group must be in the same region in which
 the operation is running.
  All Read Replicas in one region
 that are created from the same source DB instance must either:
 Specify DB subnet groups from the same VPC. All these Read
 Replicas will be created in the same VPC.
Not specify a DB
 subnet group. All these Read Replicas will be created outside of any
 VPC.
 
 Constraints: Must contain no more than
 255 alphanumeric characters, periods, underscores, spaces, or hyphens.
 Must not be default. 
Example: mySubnetgroup


storageType
String storageType
Specifies the storage type to be associated with the Read Replica. 
 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


copyTagsToSnapshot
Boolean copyTagsToSnapshot
True to copy all tags from the Read Replica to snapshots of the Read
 Replica; otherwise false. The default is false.


monitoringInterval
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring
 metrics are collected for the Read Replica. To disable collecting
 Enhanced Monitoring metrics, specify 0. The default is 60. 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


monitoringRoleArn
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring
 metrics to CloudWatch Logs. For example,
 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.








Class com.amazonaws.services.rds.model.CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBName
String dBName
The meaning of this parameter differs according to the database engine
 you use. 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:
 
 Must contain 1 to 64 alphanumeric characters
 Cannot
 be a word reserved by the specified database engine
 
 
 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: 
 Must contain 1
 to 64 alphanumeric characters
 Cannot be a word reserved by
 the specified database engine
 
  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: 
 Must contain 1 to
 63 alphanumeric characters
 Must begin with a letter or an
 underscore. Subsequent characters can be letters, underscores, or
 digits (0-9).
 Cannot be a word reserved by the specified
 database engine
 
  Oracle 
 The Oracle System ID
 (SID) of the created DB instance. 
Default: ORCL
 
Constraints: 
 Cannot be longer than 8 characters
 
  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:
 
 Must contain 1 to 64 alphanumeric characters
 Cannot
 be a word reserved by the specified database engine
 


dBInstanceIdentifier
String dBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase
 string. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens (1 to 15 for SQL Server).
 First character must be a letter.
 Cannot end with a
 hyphen or contain two consecutive hyphens.
 
 Example:
 mydbinstance


allocatedStorage
Integer allocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the
 database instance.  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)


dBInstanceClass
String dBInstanceClass
The compute and memory capacity of the DB instance.  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


engine
String engine
The name of the database engine to be used for this instance. 
 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.


masterUsername
String masterUsername
The name of master user for the client DB instance.  MySQL
 
Constraints: 
 Must be 1 to 16 alphanumeric characters.
 First character must be a letter.
 Cannot be a reserved
 word for the chosen database engine.
 
  MariaDB
 
Constraints: 
 Must be 1 to 16 alphanumeric characters.
 Cannot be a reserved word for the chosen database engine.
 
 Type: String 
 Oracle 
Constraints: 
 Must
 be 1 to 30 alphanumeric characters.
 First character must be a
 letter.
 Cannot be a reserved word for the chosen database
 engine.
 
  SQL Server 
Constraints: 
 Must
 be 1 to 128 alphanumeric characters.
 First character must be
 a letter.
 Cannot be a reserved word for the chosen database
 engine.
 
  PostgreSQL 
Constraints: 
 Must
 be 1 to 63 alphanumeric characters.
 First character must be a
 letter.
 Cannot be a reserved word for the chosen database
 engine.
 


masterUserPassword
String masterUserPassword
The password for the master database user. Can be any printable ASCII
 character except "/", """, or "@". 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.


dBSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
A list of DB security groups to associate with this DB instance. 
 Default: The default DB security group for the database engine.


vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with this DB instance.
  Default: The default EC2 VPC security group for the DB subnet
 group's VPC.


availabilityZone
String availabilityZone
The EC2 Availability Zone that the database instance will be created
 in. For information on regions and Availability Zones, see Regions
 and Availability Zones.  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.


dBSubnetGroupName
String dBSubnetGroupName
A DB subnet group to associate with this DB instance.  If there is
 no DB subnet group, then it is a non-VPC DB instance.


preferredMaintenanceWindow
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in
 Universal Coordinated Time (UTC). For more information, see DB
 Instance Maintenance.  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.


dBParameterGroupName
String dBParameterGroupName
The name of the DB parameter group to associate with this DB instance.
 If this argument is omitted, the default DBParameterGroup for the
 specified engine will be used.  Constraints: 
 Must be 1 to
 255 alphanumeric characters
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 


backupRetentionPeriod
Integer backupRetentionPeriod
The number of days for which automated backups are retained. Setting
 this parameter to a positive number enables backups. Setting this
 parameter to 0 disables automated backups.  Default: 1
 
Constraints: 
 Must be a value from 0 to 35
 Cannot
 be set to 0 if the DB instance is a source to Read Replicas
 


preferredBackupWindow
String preferredBackupWindow
The daily time range during which automated backups are created if
 automated backups are enabled, using the
 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: 
 Must be in the format
 hh24:mi-hh24:mi.
 Times should be in Universal
 Coordinated Time (UTC).
 Must not conflict with the preferred
 maintenance window.
 Must be at least 30 minutes.
 


port
Integer port
The port number on which the database accepts connections. 
 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


multiAZ
Boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment. You cannot set
 the AvailabilityZone parameter if the MultiAZ parameter is set to
 true. Do not set this value if you want a Multi-AZ deployment for a
 SQL Server DB instance. Multi-AZ for SQL Server is set using the
 Mirroring option in an option group.


engineVersion
String engineVersion
The version number of the database engine to use.  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 
 Version 5.1 (Only
 available in the following regions: ap-northeast-1, ap-southeast-1,
 ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):
  5.1.73a | 5.1.73b
 Version 5.5 (Only
 available in the following regions: ap-northeast-1, ap-southeast-1,
 ap-southeast-2, eu-west-1, sa-east-1, us-west-1, us-west-2):
  5.5.40 | 5.5.40a
 Version 5.5 (Available in
 all regions):  5.5.40b | 5.5.41 | 5.5.42
 Version 5.6 (Available in all regions):  5.6.19a |
 5.6.19b | 5.6.21 | 5.6.21b | 5.6.22 | 5.6.23 | 5.6.27
 Version 5.7 (Available in all regions): 
 5.7.10
 
 MariaDB 
 Version 10.0
 (Available in all regions except AWS GovCloud (US) Region
 (us-gov-west-1)):  10.0.17 
 
 Oracle
 Database Enterprise Edition (oracle-ee) 
 Version 11.2
 (Only available in the following regions: ap-northeast-1,
 ap-southeast-1, ap-southeast-2, eu-west-1, sa-east-1, us-west-1,
 us-west-2):  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
 Version 11.2 (Available
 in all regions):  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
 Version
 12.1 (Available in all regions): 12.1.0.1.v1 | 12.1.0.1.v2 |
 12.1.0.2.v1 
 
 Oracle Database Standard Edition
 (oracle-se) 
 Version 11.2 (Only available in the
 following regions: us-west-1):  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
 Version
 11.2 (Only available in the following regions: eu-central-1,
 us-west-1):  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
 Version
 12.1 (Only available in the following regions: eu-central-1,
 us-west-1): 12.1.0.1.v1 | 12.1.0.1.v2
 
 Oracle Database Standard Edition One (oracle-se1) 

 Version 11.2 (Only available in the following regions:
 us-west-1):  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
 Version 11.2 (Only
 available in the following regions: eu-central-1, us-west-1):
  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
 Version 12.1 (Only
 available in the following regions: eu-central-1, us-west-1):
  12.1.0.1.v1 | 12.1.0.1.v2
 
 PostgreSQL 
 Version 9.3 (Only available in the
 following regions: ap-northeast-1, ap-southeast-1, ap-southeast-2,
 eu-west-1, sa-east-1, us-west-1, us-west-2):  9.3.1 |
 9.3.2
 Version 9.3 (Available in all regions):
  9.3.3 | 9.3.5 | 9.3.6 | 9.3.9 | 9.3.10
 Version 9.4 (Available in all regions):  9.4.1 |
 9.4.4 | 9.4.5
 
 Microsoft SQL Server Enterprise
 Edition (sqlserver-ee) 
 Version 10.50 (Available in all
 regions):  10.50.2789.0.v1
 Version 10.50
 (Available in all regions):  10.50.6000.34.v1
 Version 11.00 (Available in all regions): 
 11.00.2100.60.v1
 Version 11.00 (Available in all
 regions):  11.00.5058.0.v1
 
 Microsoft
 SQL Server Express Edition (sqlserver-ex) 
 Version
 10.50 (Available in all regions): 
 10.50.2789.0.v1
 Version 10.50 (Available in all
 regions):  10.50.6000.34.v1
 Version 11.00
 (Available in all regions):  11.00.2100.60.v1
 Version 11.00 (Available in all regions): 
 11.00.5058.0.v1
 Version 12.00 (Available in all
 regions):  12.00.4422.0.v1
 
 Microsoft
 SQL Server Standard Edition (sqlserver-se) 
 Version
 10.50 (Available in all regions): 
 10.50.2789.0.v1
 Version 10.50 (Available in all
 regions):  10.50.6000.34.v1
 Version 11.00
 (Available in all regions):  11.00.2100.60.v1
 Version 11.00 (Available in all regions): 
 11.00.5058.0.v1
 Version 12.00 (Available in all
 regions):  12.00.4422.0.v1
 
 Microsoft
 SQL Server Web Edition (sqlserver-web) 
 Version 10.50
 (Available in all regions):  10.50.2789.0.v1
 Version 10.50 (Available in all regions): 
 10.50.6000.34.v1
 Version 11.00 (Available in all
 regions):  11.00.2100.60.v1
 Version 11.00
 (Available in all regions):  11.00.5058.0.v1
 Version 12.00 (Available in all regions): 
 12.00.4422.0.v1
 


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
Indicates that minor engine upgrades will be applied automatically to
 the DB instance during the maintenance window. Default:
 true


licenseModel
String licenseModel
License model information for this DB instance.  Valid values:
 license-included | bring-your-own-license |
 general-public-license


iops
Integer iops
The amount of Provisioned IOPS (input/output operations per second) to
 be initially allocated for the DB instance. Constraints: Must be a
 multiple between 3 and 10 of the storage amount for the DB instance.
 Must also be an integer multiple of 1000. For example, if the size of
 your DB instance is 500 GB, then your Iops value can be
 2000, 3000, 4000, or 5000.


optionGroupName
String optionGroupName
Indicates that the DB instance should be associated with the specified
 option group.  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


characterSetName
String characterSetName
For supported engines, indicates that the DB instance should be
 associated with the specified CharacterSet.


publiclyAccessible
Boolean publiclyAccessible
Specifies the accessibility options for the DB instance. A value of
 true specifies an Internet-facing instance with a publicly resolvable
 DNS name, which resolves to a public IP address. A value of false
 specifies an internal instance with a DNS name that resolves to a
 private IP address.  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. 
  Default VPC:
 true
  VPC: false
 
  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.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.


dBClusterIdentifier
String dBClusterIdentifier
The identifier of the DB cluster that the instance will belong to.
 For information on creating a DB cluster, see
 CreateDBCluster. 
Type: String


storageType
String storageType
Specifies the storage type to be associated with the DB instance. 
 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


tdeCredentialArn
String tdeCredentialArn
The ARN from the Key Store with which to associate the instance for
 TDE encryption.


tdeCredentialPassword
String tdeCredentialPassword
The password for the given ARN from the Key Store in order to access
 the device.


storageEncrypted
Boolean storageEncrypted
Specifies whether the DB instance is encrypted.  Default: false


kmsKeyId
String kmsKeyId
The KMS key identifier for an encrypted DB instance. 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.


domain
String domain
Specify the Active Directory Domain to create the instance in.


copyTagsToSnapshot
Boolean copyTagsToSnapshot
True to copy all tags from the DB instance to snapshots of the DB
 instance; otherwise false. The default is false.


monitoringInterval
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring
 metrics are collected for the DB instance. To disable collecting
 Enhanced Monitoring metrics, specify 0. The default is 60. 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


monitoringRoleArn
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring
 metrics to CloudWatch Logs. For example,
 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.


domainIAMRoleName
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to
 the Directory Service.


promotionTier
Integer promotionTier
A value that specifies the order in which an Aurora Replica is
 promoted to the primary instance after a failure of the existing
 primary instance. For more information, see 
 Fault Tolerance for an Aurora DB Cluster. Default: 1 
Valid
 Values: 0 - 15








Class com.amazonaws.services.rds.model.CreateDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
The name of the DB parameter group.  Constraints: 
 Must be
 1 to 255 alphanumeric characters
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 
 This value is stored as a lowercase
 string.


dBParameterGroupFamily
String dBParameterGroupFamily
The DB parameter group family name. A DB parameter group can be
 associated with one and only one DB parameter group family, and can be
 applied only to a DB instance running a database engine and engine
 version compatible with that DB parameter group family.


description
String description
The description for the DB parameter group.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CreateDBSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSecurityGroupName
String dBSecurityGroupName
The name for the DB security group. This value is stored as a
 lowercase string. Constraints: 
 Must be 1 to 255
 alphanumeric characters
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 Must not be "Default"
 Cannot contain spaces
 
 Example: mysecuritygroup


dBSecurityGroupDescription
String dBSecurityGroupDescription
The description for the DB security group.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CreateDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSnapshotIdentifier
String dBSnapshotIdentifier
The identifier for the DB snapshot. Constraints: 
 Cannot be
 null, empty, or blank
 Must contain from 1 to 255 alphanumeric
 characters or hyphens
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 
 Example: my-snapshot-id


dBInstanceIdentifier
String dBInstanceIdentifier
The DB instance identifier. This is the unique key that identifies a
 DB instance. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CreateDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName
The name for the DB subnet group. This value is stored as a lowercase
 string. Constraints: Must contain no more than 255 alphanumeric
 characters, periods, underscores, spaces, or hyphens. Must not be
 default. 
Example: mySubnetgroup


dBSubnetGroupDescription
String dBSubnetGroupDescription
The description for the DB subnet group.


subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
The EC2 Subnet IDs for the DB subnet group.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


subscriptionName
String subscriptionName
The name of the subscription. Constraints: The name must be less
 than 255 characters.


snsTopicArn
String snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event
 notification. The ARN is created by Amazon SNS when you create a topic
 and subscribe to it.


sourceType
String sourceType
The type of source that will be generating the events. For example, if
 you want to be notified of events generated by a DB instance, you
 would set this parameter to db-instance. if this value is not
 specified, all events are returned. Valid values: db-instance |
 db-parameter-group | db-security-group | db-snapshot


eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
A list of event categories for a SourceType that you want to subscribe
 to. You can see a list of the categories for a given SourceType in the
 Events
 topic in the Amazon RDS User Guide or by using the
 DescribeEventCategories action.


sourceIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIds
The list of identifiers of the event sources for which events will be
 returned. If not specified, then all sources are included in the
 response. An identifier must begin with a letter and must contain only
 ASCII letters, digits, and hyphens; it cannot end with a hyphen or
 contain two consecutive hyphens. Constraints: 
 If SourceIds
 are supplied, SourceType must also be provided.
 If the source
 type is a DB instance, then a DBInstanceIdentifier must
 be supplied.
 If the source type is a DB security group, a
 DBSecurityGroupName must be supplied.
 If the
 source type is a DB parameter group, a
 DBParameterGroupName must be supplied.
 If the
 source type is a DB snapshot, a DBSnapshotIdentifier must
 be supplied.
 


enabled
Boolean enabled
A Boolean value; set to true to activate the subscription, set
 to false to create the subscription but not active it.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.CreateOptionGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


optionGroupName
String optionGroupName
Specifies the name of the option group to be created.  Constraints:
 
 Must be 1 to 255 alphanumeric characters or hyphens
 First character must be a letter
 Cannot end with a hyphen
 or contain two consecutive hyphens
 
 Example:
 myoptiongroup


engineName
String engineName
Specifies the name of the engine that this option group should be
 associated with.


majorEngineVersion
String majorEngineVersion
Specifies the major version of the engine that this option group
 should be associated with.


optionGroupDescription
String optionGroupDescription
The description of the option group.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.DBCluster extends Object implements Serializable




Serialized Fields


allocatedStorage
Integer allocatedStorage
Specifies the allocated storage size in gigabytes (GB).


availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Provides the list of EC2 Availability Zones that instances in the DB
 cluster can be created in.


backupRetentionPeriod
Integer backupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are
 retained.


characterSetName
String characterSetName
If present, specifies the name of the character set that this cluster
 is associated with.


databaseName
String databaseName
Contains the name of the initial database of this DB cluster that was
 provided at create time, if one was specified when the DB cluster was
 created. This same name is returned for the life of the DB cluster.


dBClusterIdentifier
String dBClusterIdentifier
Contains a user-supplied DB cluster identifier. This identifier is the
 unique key that identifies a DB cluster.


dBClusterParameterGroup
String dBClusterParameterGroup
Specifies the name of the DB cluster parameter group for the DB
 cluster.


dBSubnetGroup
String dBSubnetGroup
Specifies information on the subnet group associated with the DB
 cluster, including the name, description, and subnets in the subnet
 group.


status
String status
Specifies the current state of this DB cluster.


percentProgress
String percentProgress
Specifies the progress of the operation as a percentage.


earliestRestorableTime
Date earliestRestorableTime
Specifies the earliest time to which a database can be restored with
 point-in-time restore.


endpoint
String endpoint
Specifies the connection endpoint for the primary instance of the DB
 cluster.


engine
String engine
Provides the name of the database engine to be used for this DB
 cluster.


engineVersion
String engineVersion
Indicates the database engine version.


latestRestorableTime
Date latestRestorableTime
Specifies the latest time to which a database can be restored with
 point-in-time restore.


port
Integer port
Specifies the port that the database engine is listening on.


masterUsername
String masterUsername
Contains the master username for the DB cluster.


dBClusterOptionGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterOptionGroupMemberships
Provides the list of option group memberships for this DB cluster.


preferredBackupWindow
String preferredBackupWindow
Specifies the daily time range during which automated backups are
 created if automated backups are enabled, as determined by the
 BackupRetentionPeriod.


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can
 occur, in Universal Coordinated Time (UTC).


dBClusterMembers
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterMembers
Provides the list of instances that make up the DB cluster.


vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
Provides a list of VPC security groups that the DB cluster belongs to.


hostedZoneId
String hostedZoneId
Specifies the ID that Amazon Route 53 assigns when you create a hosted
 zone.


storageEncrypted
Boolean storageEncrypted
Specifies whether the DB cluster is encrypted.


kmsKeyId
String kmsKeyId
If StorageEncrypted is true, the KMS key identifier for
 the encrypted DB cluster.


dbClusterResourceId
String dbClusterResourceId
The region-unique, immutable identifier for the DB cluster. This
 identifier is found in AWS CloudTrail log entries whenever the KMS key
 for the DB cluster is accessed.








Class com.amazonaws.services.rds.model.DBClusterAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBClusterMember extends Object implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
Specifies the instance identifier for this member of the DB cluster.


isClusterWriter
Boolean isClusterWriter
Value that is true if the cluster member is the primary
 instance for the DB cluster and false otherwise.


dBClusterParameterGroupStatus
String dBClusterParameterGroupStatus
Specifies the status of the DB cluster parameter group for this member
 of the DB cluster.


promotionTier
Integer promotionTier
A value that specifies the order in which an Aurora Replica is
 promoted to the primary instance after a failure of the existing
 primary instance. For more information, see 
 Fault Tolerance for an Aurora DB Cluster.








Class com.amazonaws.services.rds.model.DBClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBClusterOptionGroupStatus extends Object implements Serializable




Serialized Fields


dBClusterOptionGroupName
String dBClusterOptionGroupName
Specifies the name of the DB cluster option group.


status
String status
Specifies the status of the DB cluster option group.








Class com.amazonaws.services.rds.model.DBClusterParameterGroup extends Object implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
Provides the name of the DB cluster parameter group.


dBParameterGroupFamily
String dBParameterGroupFamily
Provides the name of the DB parameter group family that this DB
 cluster parameter group is compatible with.


description
String description
Provides the customer-specified description for this DB cluster
 parameter group.








Class com.amazonaws.services.rds.model.DBClusterParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBClusterQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBClusterSnapshot extends Object implements Serializable




Serialized Fields


availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Provides the list of EC2 Availability Zones that instances in the DB
 cluster snapshot can be restored in.


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier
Specifies the identifier for the DB cluster snapshot.


dBClusterIdentifier
String dBClusterIdentifier
Specifies the DB cluster identifier of the DB cluster that this DB
 cluster snapshot was created from.


snapshotCreateTime
Date snapshotCreateTime
Provides the time when the snapshot was taken, in Universal
 Coordinated Time (UTC).


engine
String engine
Specifies the name of the database engine.


allocatedStorage
Integer allocatedStorage
Specifies the allocated storage size in gigabytes (GB).


status
String status
Specifies the status of this DB cluster snapshot.


port
Integer port
Specifies the port that the DB cluster was listening on at the time of
 the snapshot.


vpcId
String vpcId
Provides the VPC ID associated with the DB cluster snapshot.


clusterCreateTime
Date clusterCreateTime
Specifies the time when the DB cluster was created, in Universal
 Coordinated Time (UTC).


masterUsername
String masterUsername
Provides the master username for the DB cluster snapshot.


engineVersion
String engineVersion
Provides the version of the database engine for this DB cluster
 snapshot.


licenseModel
String licenseModel
Provides the license model information for this DB cluster snapshot.


snapshotType
String snapshotType
Provides the type of the DB cluster snapshot.


percentProgress
Integer percentProgress
Specifies the percentage of the estimated data that has been
 transferred.


storageEncrypted
Boolean storageEncrypted
Specifies whether the DB cluster snapshot is encrypted.


kmsKeyId
String kmsKeyId
If StorageEncrypted is true, the KMS key identifier for
 the encrypted DB cluster snapshot.








Class com.amazonaws.services.rds.model.DBClusterSnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBClusterSnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBEngineVersion extends Object implements Serializable




Serialized Fields


engine
String engine
The name of the database engine.


engineVersion
String engineVersion
The version number of the database engine.


dBParameterGroupFamily
String dBParameterGroupFamily
The name of the DB parameter group family for the database engine.


dBEngineDescription
String dBEngineDescription
The description of the database engine.


dBEngineVersionDescription
String dBEngineVersionDescription
The description of the database engine version.


defaultCharacterSet
CharacterSet defaultCharacterSet
The default character set for new instances of this engine version, if
 the CharacterSetName parameter of the CreateDBInstance
 API is not specified.


supportedCharacterSets
com.amazonaws.internal.ListWithAutoConstructFlag<T> supportedCharacterSets
A list of the character sets supported by this engine for the
 CharacterSetName parameter of the CreateDBInstance API.


validUpgradeTarget
com.amazonaws.internal.ListWithAutoConstructFlag<T> validUpgradeTarget
A list of engine versions that this database engine version can be
 upgraded to.








Class com.amazonaws.services.rds.model.DBInstance extends Object implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
Contains a user-supplied database identifier. This identifier is the
 unique key that identifies a DB instance.


dBInstanceClass
String dBInstanceClass
Contains the name of the compute and memory capacity class of the DB
 instance.


engine
String engine
Provides the name of the database engine to be used for this DB
 instance.


dBInstanceStatus
String dBInstanceStatus
Specifies the current state of this database.


masterUsername
String masterUsername
Contains the master username for the DB instance.


dBName
String dBName
The meaning of this parameter differs according to the database engine
 you use. For example, this value returns MySQL, MariaDB, or PostgreSQL
 information when returning values from CreateDBInstanceReadReplica
 since Read Replicas are only supported for these engines. 
 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 endpoint
Specifies the connection endpoint.


allocatedStorage
Integer allocatedStorage
Specifies the allocated storage size specified in gigabytes.


instanceCreateTime
Date instanceCreateTime
Provides the date and time the DB instance was created.


preferredBackupWindow
String preferredBackupWindow
Specifies the daily time range during which automated backups are
 created if automated backups are enabled, as determined by the
 BackupRetentionPeriod.


backupRetentionPeriod
Integer backupRetentionPeriod
Specifies the number of days for which automatic DB snapshots are
 retained.


dBSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
Provides List of DB security group elements containing only
 DBSecurityGroup.Name and
 DBSecurityGroup.Status subelements.


vpcSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroups
Provides List of VPC security group elements that the DB instance
 belongs to.


dBParameterGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
Provides the list of DB parameter groups applied to this DB instance.


availabilityZone
String availabilityZone
Specifies the name of the Availability Zone the DB instance is located
 in.


dBSubnetGroup
DBSubnetGroup dBSubnetGroup
Specifies information on the subnet group associated with the DB
 instance, including the name, description, and subnets in the subnet
 group.


preferredMaintenanceWindow
String preferredMaintenanceWindow
Specifies the weekly time range during which system maintenance can
 occur, in Universal Coordinated Time (UTC).


pendingModifiedValues
PendingModifiedValues pendingModifiedValues
Specifies that changes to the DB instance are pending. This element is
 only included when changes are pending. Specific changes are
 identified by subelements.


latestRestorableTime
Date latestRestorableTime
Specifies the latest time to which a database can be restored with
 point-in-time restore.


multiAZ
Boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment.


engineVersion
String engineVersion
Indicates the database engine version.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
Indicates that minor version patches are applied automatically.


readReplicaSourceDBInstanceIdentifier
String readReplicaSourceDBInstanceIdentifier
Contains the identifier of the source DB instance if this DB instance
 is a Read Replica.


readReplicaDBInstanceIdentifiers
com.amazonaws.internal.ListWithAutoConstructFlag<T> readReplicaDBInstanceIdentifiers
Contains one or more identifiers of the Read Replicas associated with
 this DB instance.


licenseModel
String licenseModel
License model information for this DB instance.


iops
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value.


optionGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupMemberships
Provides the list of option group memberships for this DB instance.


characterSetName
String characterSetName
If present, specifies the name of the character set that this instance
 is associated with.


secondaryAvailabilityZone
String secondaryAvailabilityZone
If present, specifies the name of the secondary Availability Zone for
 a DB instance with multi-AZ support.


publiclyAccessible
Boolean publiclyAccessible
Specifies the accessibility options for the DB instance. A value of
 true specifies an Internet-facing instance with a publicly resolvable
 DNS name, which resolves to a public IP address. A value of false
 specifies an internal instance with a DNS name that resolves to a
 private IP address.  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. 
  Default
 VPC:true
  VPC:false
 
  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.


statusInfos
com.amazonaws.internal.ListWithAutoConstructFlag<T> statusInfos
The status of a Read Replica. If the instance is not a Read Replica,
 this will be blank.


storageType
String storageType
Specifies the storage type associated with DB instance.


tdeCredentialArn
String tdeCredentialArn
The ARN from the Key Store with which the instance is associated for
 TDE encryption.


dbInstancePort
Integer dbInstancePort
Specifies the port that the DB instance listens on. If the DB instance
 is part of a DB cluster, this can be a different port than the DB
 cluster port.


dBClusterIdentifier
String dBClusterIdentifier
If the DB instance is a member of a DB cluster, contains the name of
 the DB cluster that the DB instance is a member of.


storageEncrypted
Boolean storageEncrypted
Specifies whether the DB instance is encrypted.


kmsKeyId
String kmsKeyId
If StorageEncrypted is true, the KMS key identifier for
 the encrypted DB instance.


dbiResourceId
String dbiResourceId
The region-unique, immutable identifier for the DB instance. This
 identifier is found in AWS CloudTrail log entries whenever the KMS key
 for the DB instance is accessed.


cACertificateIdentifier
String cACertificateIdentifier
The identifier of the CA certificate for this DB instance.


domainMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> domainMemberships
The Active Directory Domain membership records associated with the DB
 instance.


copyTagsToSnapshot
Boolean copyTagsToSnapshot
Specifies whether tags are copied from the DB instance to snapshots of
 the DB instance.


monitoringInterval
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring
 metrics are collected for the DB instance.


enhancedMonitoringResourceArn
String enhancedMonitoringResourceArn
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log
 stream that receives the Enhanced Monitoring metrics data for the DB
 instance.


monitoringRoleArn
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send Enhanced Monitoring
 metrics to CloudWatch Logs.


promotionTier
Integer promotionTier
A value that specifies the order in which an Aurora Replica is
 promoted to the primary instance after a failure of the existing
 primary instance. For more information, see 
 Fault Tolerance for an Aurora DB Cluster.








Class com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBInstanceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBInstanceStatusInfo extends Object implements Serializable




Serialized Fields


statusType
String statusType
This value is currently "read replication."


normal
Boolean normal
Boolean value that is true if the instance is operating normally, or
 false if the instance is in an error state.


status
String status
Status of the DB instance. For a StatusType of read replica, the
 values can be replicating, error, stopped, or terminated.


message
String message
Details of the error if there is an error for the instance. If the
 instance is not in an error state, this value is blank.








Class com.amazonaws.services.rds.model.DBLogFileNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBParameterGroup extends Object implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
Provides the name of the DB parameter group.


dBParameterGroupFamily
String dBParameterGroupFamily
Provides the name of the DB parameter group family that this DB
 parameter group is compatible with.


description
String description
Provides the customer-specified description for this DB parameter
 group.








Class com.amazonaws.services.rds.model.DBParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBParameterGroupStatus extends Object implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
The name of the DP parameter group.


parameterApplyStatus
String parameterApplyStatus
The status of parameter updates.








Class com.amazonaws.services.rds.model.DBSecurityGroup extends Object implements Serializable




Serialized Fields


ownerId
String ownerId
Provides the AWS ID of the owner of a specific DB security group.


dBSecurityGroupName
String dBSecurityGroupName
Specifies the name of the DB security group.


dBSecurityGroupDescription
String dBSecurityGroupDescription
Provides the description of the DB security group.


vpcId
String vpcId
Provides the VpcId of the DB security group.


eC2SecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> eC2SecurityGroups
Contains a list of EC2SecurityGroup elements.


iPRanges
com.amazonaws.internal.ListWithAutoConstructFlag<T> iPRanges
Contains a list of IPRange elements.








Class com.amazonaws.services.rds.model.DBSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSecurityGroupMembership extends Object implements Serializable




Serialized Fields


dBSecurityGroupName
String dBSecurityGroupName
The name of the DB security group.


status
String status
The status of the DB security group.








Class com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSecurityGroupNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSnapshot extends Object implements Serializable




Serialized Fields


dBSnapshotIdentifier
String dBSnapshotIdentifier
Specifies the identifier for the DB snapshot.


dBInstanceIdentifier
String dBInstanceIdentifier
Specifies the DB instance identifier of the DB instance this DB
 snapshot was created from.


snapshotCreateTime
Date snapshotCreateTime
Provides the time when the snapshot was taken, in Universal
 Coordinated Time (UTC).


engine
String engine
Specifies the name of the database engine.


allocatedStorage
Integer allocatedStorage
Specifies the allocated storage size in gigabytes (GB).


status
String status
Specifies the status of this DB snapshot.


port
Integer port
Specifies the port that the database engine was listening on at the
 time of the snapshot.


availabilityZone
String availabilityZone
Specifies the name of the Availability Zone the DB instance was
 located in at the time of the DB snapshot.


vpcId
String vpcId
Provides the VPC ID associated with the DB snapshot.


instanceCreateTime
Date instanceCreateTime
Specifies the time when the snapshot was taken, in Universal
 Coordinated Time (UTC).


masterUsername
String masterUsername
Provides the master username for the DB snapshot.


engineVersion
String engineVersion
Specifies the version of the database engine.


licenseModel
String licenseModel
License model information for the restored DB instance.


snapshotType
String snapshotType
Provides the type of the DB snapshot.


iops
Integer iops
Specifies the Provisioned IOPS (I/O operations per second) value of
 the DB instance at the time of the snapshot.


optionGroupName
String optionGroupName
Provides the option group name for the DB snapshot.


percentProgress
Integer percentProgress
The percentage of the estimated data that has been transferred.


sourceRegion
String sourceRegion
The region that the DB snapshot was created in or copied from.


sourceDBSnapshotIdentifier
String sourceDBSnapshotIdentifier
The DB snapshot Arn that the DB snapshot was copied from. It only has
 value in case of cross customer or cross region copy.


storageType
String storageType
Specifies the storage type associated with DB Snapshot.


tdeCredentialArn
String tdeCredentialArn
The ARN from the Key Store with which to associate the instance for
 TDE encryption.


encrypted
Boolean encrypted
Specifies whether the DB snapshot is encrypted.


kmsKeyId
String kmsKeyId
If Encrypted is true, the KMS key identifier for the
 encrypted DB snapshot.








Class com.amazonaws.services.rds.model.DBSnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSnapshotAttribute extends Object implements Serializable




Serialized Fields


attributeName
String attributeName
The name of the manual DB snapshot attribute. An attribute name of
 restore applies to the list of AWS accounts that have
 permission to copy or restore the manual DB snapshot.


attributeValues
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValues
The value(s) for the manual DB snapshot attribute. 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.








Class com.amazonaws.services.rds.model.DBSnapshotAttributesResult extends Object implements Serializable




Serialized Fields


dBSnapshotIdentifier
String dBSnapshotIdentifier
The identifier of the manual DB snapshot that the attributes apply to.


dBSnapshotAttributes
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshotAttributes
The list of attributes and values for the manual DB snapshot.








Class com.amazonaws.services.rds.model.DBSnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSubnetGroup extends Object implements Serializable




Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName
The name of the DB subnet group.


dBSubnetGroupDescription
String dBSubnetGroupDescription
Provides the description of the DB subnet group.


vpcId
String vpcId
Provides the VpcId of the DB subnet group.


subnetGroupStatus
String subnetGroupStatus
Provides the status of the DB subnet group.


subnets
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnets
Contains a list of Subnet elements.








Class com.amazonaws.services.rds.model.DBSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSubnetGroupNotAllowedException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBSubnetQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DBUpgradeDependencyFailureException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DeleteDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group. Constraints: 

 Must be the name of an existing DB cluster parameter group.
 You cannot delete a default DB cluster parameter group.
 Cannot be associated with any DB clusters.
 








Class com.amazonaws.services.rds.model.DeleteDBClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier
The DB cluster identifier for the DB cluster to be deleted. This
 parameter isn't case-sensitive. Constraints: 
 Must contain
 from 1 to 63 alphanumeric characters or hyphens
 First
 character must be a letter
 Cannot end with a hyphen or
 contain two consecutive hyphens
 


skipFinalSnapshot
Boolean skipFinalSnapshot
Determines whether a final DB cluster snapshot is created before the
 DB cluster is deleted. If 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.
 You must specify a FinalDBSnapshotIdentifier
 parameter if SkipFinalSnapshot is
 false. Default: false


finalDBSnapshotIdentifier
String finalDBSnapshotIdentifier
The DB cluster snapshot identifier of the new DB cluster snapshot
 created when SkipFinalSnapshot is set to
 false.  Specifying this parameter and also setting
 the SkipFinalShapshot parameter to true results in an
 error.  Constraints: 
 Must be 1 to 255 alphanumeric
 characters
 First character must be a letter
 Cannot
 end with a hyphen or contain two consecutive hyphens
 








Class com.amazonaws.services.rds.model.DeleteDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier
The identifier of the DB cluster snapshot to delete. Constraints:
 Must be the name of an existing DB cluster snapshot in the
 available state.








Class com.amazonaws.services.rds.model.DeleteDBInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The DB instance identifier for the DB instance to be deleted. This
 parameter isn't case-sensitive. Constraints: 
 Must contain
 from 1 to 63 alphanumeric characters or hyphens
 First
 character must be a letter
 Cannot end with a hyphen or
 contain two consecutive hyphens
 


skipFinalSnapshot
Boolean skipFinalSnapshot
Determines whether a final DB snapshot is created before the DB
 instance is deleted. If 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. The
 FinalDBSnapshotIdentifier parameter must be specified if
 SkipFinalSnapshot is false. 
Default:
 false


finalDBSnapshotIdentifier
String finalDBSnapshotIdentifier
The DBSnapshotIdentifier of the new DBSnapshot created when
 SkipFinalSnapshot is set to false.  Specifying this
 parameter and also setting the SkipFinalShapshot parameter to true
 results in an error.  Constraints: 
 Must be 1 to 255
 alphanumeric characters
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 Cannot be specified when deleting a Read Replica.
 








Class com.amazonaws.services.rds.model.DeleteDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
The name of the DB parameter group. Constraints: 
 Must be
 the name of an existing DB parameter group
 You cannot delete
 a default DB parameter group
 Cannot be associated with any DB
 instances
 








Class com.amazonaws.services.rds.model.DeleteDBSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSecurityGroupName
String dBSecurityGroupName
The name of the DB security group to delete. You cannot delete
 the default DB security group.  Constraints: 
 Must
 be 1 to 255 alphanumeric characters
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 Must not be "Default"
 Cannot contain
 spaces
 








Class com.amazonaws.services.rds.model.DeleteDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSnapshotIdentifier
String dBSnapshotIdentifier
The DBSnapshot identifier. Constraints: Must be the name of an
 existing DB snapshot in the available state.








Class com.amazonaws.services.rds.model.DeleteDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName
The name of the database subnet group to delete. You cannot
 delete the default subnet group.  Constraints:
 
Constraints: Must contain no more than 255 alphanumeric characters,
 periods, underscores, spaces, or hyphens. Must not be default.
 
Example: mySubnetgroup








Class com.amazonaws.services.rds.model.DeleteEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


subscriptionName
String subscriptionName
The name of the RDS event notification subscription you want to
 delete.








Class com.amazonaws.services.rds.model.DeleteOptionGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


optionGroupName
String optionGroupName
The name of the option group to be deleted. You cannot delete
 default option groups.








Class com.amazonaws.services.rds.model.DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable




Class com.amazonaws.services.rds.model.DescribeAccountAttributesResult extends Object implements Serializable




Serialized Fields


accountQuotas
com.amazonaws.internal.ListWithAutoConstructFlag<T> accountQuotas
A list of AccountQuota objects. Within this list, each quota
 has a name, a count of usage toward the quota maximum, and a maximum
 value for the quota.








Class com.amazonaws.services.rds.model.DescribeCertificatesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


certificateIdentifier
String certificateIdentifier
The user-supplied certificate identifier. If this parameter is
 specified, information for only the identified certificate is
 returned. This parameter isn't case-sensitive. Constraints: 

 Must contain from 1 to 63 alphanumeric characters or hyphens
 First character must be a letter
 Cannot end with a hyphen
 or contain two consecutive hyphens
 


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeCertificates request. If this parameter is specified,
 the response includes only records beyond the marker, up to the value
 specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeCertificatesResult extends Object implements Serializable




Serialized Fields


certificates
com.amazonaws.internal.ListWithAutoConstructFlag<T> certificates
The list of Certificate objects for the AWS account.


marker
String marker
An optional pagination token provided by a previous
 DescribeCertificates request. If this parameter is specified,
 the response includes only records beyond the marker, up to the value
 specified by MaxRecords .








Class com.amazonaws.services.rds.model.DescribeDBClusterParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return details
 for. Constraints: 
 Must be 1 to 255 alphanumeric
 characters
 First character must be a letter
 Cannot
 end with a hyphen or contain two consecutive hyphens
 


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBClusterParameterGroups request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBClusterParameterGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous
 DescribeDBClusterParameterGroups request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


dBClusterParameterGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterParameterGroups
A list of DB cluster parameter groups.








Class com.amazonaws.services.rds.model.DescribeDBClusterParametersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of a specific DB cluster parameter group to return parameter
 details for. Constraints: 
 Must be 1 to 255 alphanumeric
 characters
 First character must be a letter
 Cannot
 end with a hyphen or contain two consecutive hyphens
 


source
String source
A value that indicates to return only parameters for a specific
 source. Parameter sources can be engine,
 service, or customer.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBClusterParameters request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBClusterParametersResult extends Object implements Serializable




Serialized Fields


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Provides a list of parameters for the DB cluster parameter group.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBClusterParameters request. If this parameter is specified,
 the response includes only records beyond the marker, up to the value
 specified by MaxRecords .








Class com.amazonaws.services.rds.model.DescribeDBClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier
A DB cluster identifier to retrieve the list of DB cluster snapshots
 for. This parameter cannot be used in conjunction with the
 DBClusterSnapshotIdentifier parameter. This parameter is
 not case-sensitive. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 


dBClusterSnapshotIdentifier
String dBClusterSnapshotIdentifier
A specific DB cluster snapshot identifier to describe. This parameter
 cannot be used in conjunction with the
 DBClusterIdentifier parameter. This value is stored as a
 lowercase string. Constraints: 
 Must be 1 to 255
 alphanumeric characters
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 If this is the identifier of an automated snapshot, the
 SnapshotType parameter must also be specified.
 


snapshotType
String snapshotType
The type of DB cluster snapshots that will be returned. Values can be
 automated or manual. If this parameter is
 not specified, the returned results will include all snapshot types.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBClusterSnapshots request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBClusterSnapshotsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous
 DescribeDBClusterSnapshots request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.


dBClusterSnapshots
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusterSnapshots
Provides a list of DB cluster snapshots for the user.








Class com.amazonaws.services.rds.model.DescribeDBClustersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier
The user-supplied DB cluster identifier. If this parameter is
 specified, information from only the specific DB cluster is returned.
 This parameter isn't case-sensitive. Constraints: 
 Must
 contain from 1 to 63 alphanumeric characters or hyphens
 First
 character must be a letter
 Cannot end with a hyphen or
 contain two consecutive hyphens
 


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBClusters request. If this parameter is specified, the
 response includes only records beyond the marker, up to the value
 specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBClustersResult extends Object implements Serializable




Serialized Fields


marker
String marker
A pagination token that can be used in a subsequent DescribeDBClusters
 request.


dBClusters
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBClusters
Contains a list of DB clusters for the user.








Class com.amazonaws.services.rds.model.DescribeDBEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


engine
String engine
The database engine to return.


engineVersion
String engineVersion
The database engine version to return. Example: 5.1.49


dBParameterGroupFamily
String dBParameterGroupFamily
The name of a specific DB parameter group family to return details
 for. Constraints: 
 Must be 1 to 255 alphanumeric
 characters
 First character must be a letter
 Cannot
 end with a hyphen or contain two consecutive hyphens
 


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more than
 the 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.


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


defaultOnly
Boolean defaultOnly
Indicates that only the default version of the specified engine or
 engine and major version combination is returned.


listSupportedCharacterSets
Boolean listSupportedCharacterSets
If this parameter is specified, and if the requested engine supports
 the CharacterSetName parameter for CreateDBInstance, the response
 includes a list of supported character sets for each engine version.








Class com.amazonaws.services.rds.model.DescribeDBEngineVersionsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


dBEngineVersions
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBEngineVersions
A list of DBEngineVersion elements.








Class com.amazonaws.services.rds.model.DescribeDBInstancesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The user-supplied instance identifier. If this parameter is specified,
 information from only the specific DB instance is returned. This
 parameter isn't case-sensitive. Constraints: 
 Must contain
 from 1 to 63 alphanumeric characters or hyphens
 First
 character must be a letter
 Cannot end with a hyphen or
 contain two consecutive hyphens
 


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBInstances request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBInstancesResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords .


dBInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBInstances
A list of DBInstance instances.








Class com.amazonaws.services.rds.model.DescribeDBLogFilesDetails extends Object implements Serializable




Serialized Fields


logFileName
String logFileName
The name of the log file for the specified DB instance.


lastWritten
Long lastWritten
A POSIX timestamp when the last log entry was written.


size
Long size
The size, in bytes, of the log file for the specified DB instance.








Class com.amazonaws.services.rds.model.DescribeDBLogFilesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The customer-assigned name of the DB instance that contains the log
 files you want to list. Constraints: 
 Must contain from 1
 to 63 alphanumeric characters or hyphens
 First character must
 be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 


filenameContains
String filenameContains
Filters the available log files for log file names that contain the
 specified string.


fileLastWritten
Long fileLastWritten
Filters the available log files for files written since the specified
 date, in POSIX timestamp format with milliseconds.


fileSize
Long fileSize
Filters the available log files for files larger than the specified
 size.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified MaxRecords value, a pagination token
 called a marker is included in the response so that the remaining
 results can be retrieved.


marker
String marker
The pagination token provided in the previous request. If this
 parameter is specified the response includes only records beyond the
 marker, up to MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBLogFilesResult extends Object implements Serializable




Serialized Fields


describeDBLogFiles
com.amazonaws.internal.ListWithAutoConstructFlag<T> describeDBLogFiles
The DB log files returned.


marker
String marker
A pagination token that can be used in a subsequent DescribeDBLogFiles
 request.








Class com.amazonaws.services.rds.model.DescribeDBParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
 Constraints: 
 Must be 1 to 255 alphanumeric characters
 First character must be a letter
 Cannot end with a hyphen
 or contain two consecutive hyphens
 


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBParameterGroups request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBParameterGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


dBParameterGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBParameterGroups
A list of DBParameterGroup instances.








Class com.amazonaws.services.rds.model.DescribeDBParametersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
The name of a specific DB parameter group to return details for.
 Constraints: 
 Must be 1 to 255 alphanumeric characters
 First character must be a letter
 Cannot end with a hyphen
 or contain two consecutive hyphens
 


source
String source
The parameter types to return. Default: All parameter types
 returned 
Valid Values: user | system | engine-default


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBParameters request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBParametersResult extends Object implements Serializable




Serialized Fields


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
A list of Parameter values.


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSecurityGroupName
String dBSecurityGroupName
The name of the DB security group to return details for.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBSecurityGroups request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBSecurityGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


dBSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
A list of DBSecurityGroup instances.








Class com.amazonaws.services.rds.model.DescribeDBSnapshotAttributesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSnapshotIdentifier
String dBSnapshotIdentifier
The identifier for the DB snapshot to modify the attributes for.








Class com.amazonaws.services.rds.model.DescribeDBSnapshotsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
A DB instance identifier to retrieve the list of DB snapshots for.
 This parameter cannot be used in conjunction with
 DBSnapshotIdentifier. This parameter is not
 case-sensitive. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 


dBSnapshotIdentifier
String dBSnapshotIdentifier
A specific DB snapshot identifier to describe. This parameter cannot
 be used in conjunction with DBInstanceIdentifier. This
 value is stored as a lowercase string. Constraints: 
 Must
 be 1 to 255 alphanumeric characters.
 First character must be
 a letter.
 Cannot end with a hyphen or contain two consecutive
 hyphens.
 If this is the identifier of an automated snapshot,
 the SnapshotType parameter must also be specified.
 


snapshotType
String snapshotType
The type of snapshots that will be returned. You can specify one of
 the following values:  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.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBSnapshots request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.


includeShared
Boolean includeShared
True to include shared manual DB snapshots from other AWS accounts
 that this AWS account has been given permission to copy or restore;
 otherwise false. The default is false. An AWS account is given
 permission to restore a manual DB snapshot from another AWS account by
 the ModifyDBSnapshotAttribute API.


includePublic
Boolean includePublic
True to include manual DB snapshots that are public and can be copied
 or restored by any AWS account; otherwise false. The default is false.
 An manual DB snapshot is shared as public by the
 ModifyDBSnapshotAttribute API.








Class com.amazonaws.services.rds.model.DescribeDBSnapshotsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


dBSnapshots
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSnapshots
A list of DBSnapshot instances.








Class com.amazonaws.services.rds.model.DescribeDBSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName
The name of the DB subnet group to return details for.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeDBSubnetGroups request. If this parameter is specified, the
 response includes only records beyond the marker, up to the value
 specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeDBSubnetGroupsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


dBSubnetGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSubnetGroups
A list of DBSubnetGroup instances.








Class com.amazonaws.services.rds.model.DescribeEngineDefaultClusterParametersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily
The name of the DB cluster parameter group family to return engine
 parameter information for.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeEngineDefaultClusterParameters request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeEngineDefaultParametersRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily
The name of the DB parameter group family.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
Not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeEngineDefaultParameters request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeEventCategoriesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceType
String sourceType
The type of source that will be generating the events. Valid
 values: db-instance | db-parameter-group | db-security-group |
 db-snapshot


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.








Class com.amazonaws.services.rds.model.DescribeEventCategoriesResult extends Object implements Serializable




Serialized Fields


eventCategoriesMapList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesMapList
A list of EventCategoriesMap data types.








Class com.amazonaws.services.rds.model.DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


sourceIdentifier
String sourceIdentifier
The identifier of the event source for which events will be returned.
 If not specified, then all sources are included in the response.
 Constraints: 
 If SourceIdentifier is supplied, SourceType
 must also be provided.
 If the source type is
 DBInstance, then a DBInstanceIdentifier must
 be supplied.
 If the source type is
 DBSecurityGroup, a DBSecurityGroupName must
 be supplied.
 If the source type is
 DBParameterGroup, a DBParameterGroupName
 must be supplied.
 If the source type is
 DBSnapshot, a DBSnapshotIdentifier must be
 supplied.
 Cannot end with a hyphen or contain two consecutive
 hyphens.
 


sourceType
String sourceType
The event source to retrieve events for. If no value is specified, all
 events are returned.
 
 Constraints:

 Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot


startTime
Date startTime
The beginning of the time interval to retrieve events for, specified
 in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia
 page. Example: 2009-07-08T18:00Z


endTime
Date endTime
The end of the time interval for which to retrieve events, specified
 in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia
 page. Example: 2009-07-08T18:00Z


duration
Integer duration
The number of minutes to retrieve events for. Default: 60


eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
A list of event categories that trigger notifications for a event
 notification subscription.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous DescribeEvents
 request. If this parameter is specified, the response includes only
 records beyond the marker, up to the value specified by
 MaxRecords.








Class com.amazonaws.services.rds.model.DescribeEventsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous Events request. If
 this parameter is specified, the response includes only records beyond
 the marker, up to the value specified by MaxRecords .


events
com.amazonaws.internal.ListWithAutoConstructFlag<T> events
A list of Event instances.








Class com.amazonaws.services.rds.model.DescribeEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


subscriptionName
String subscriptionName
The name of the RDS event notification subscription you want to
 describe.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeOrderableDBInstanceOptions request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords .








Class com.amazonaws.services.rds.model.DescribeEventSubscriptionsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous
 DescribeOrderableDBInstanceOptions request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords.


eventSubscriptionsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventSubscriptionsList
A list of EventSubscriptions data types.








Class com.amazonaws.services.rds.model.DescribeOptionGroupOptionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


engineName
String engineName
A required parameter. Options available for the given engine name will
 be described.


majorEngineVersion
String majorEngineVersion
If specified, filters the results to include only options for the
 specified major engine version.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeOptionGroupOptionsResult extends Object implements Serializable




Serialized Fields


optionGroupOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptions
List of available option group options.


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeOptionGroupsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


optionGroupName
String optionGroupName
The name of the option group to describe. Cannot be supplied together
 with EngineName or MajorEngineVersion.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


marker
String marker
An optional pagination token provided by a previous
 DescribeOptionGroups request. If this parameter is specified, the
 response includes only records beyond the marker, up to the value
 specified by MaxRecords.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


engineName
String engineName
Filters the list of option groups to only include groups associated
 with a specific database engine.


majorEngineVersion
String majorEngineVersion
Filters the list of option groups to only include groups associated
 with a specific database engine version. If specified, then EngineName
 must also be specified.








Class com.amazonaws.services.rds.model.DescribeOptionGroupsResult extends Object implements Serializable




Serialized Fields


optionGroupsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupsList
List of option groups.


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeOrderableDBInstanceOptionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


engine
String engine
The name of the engine to retrieve DB instance options for.


engineVersion
String engineVersion
The engine version filter value. Specify this parameter to show only
 the available offerings matching the specified engine version.


dBInstanceClass
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show
 only the available offerings matching the specified DB instance class.


licenseModel
String licenseModel
The license model filter value. Specify this parameter to show only
 the available offerings matching the specified license model.


vpc
Boolean vpc
The VPC filter value. Specify this parameter to show only the
 available VPC or non-VPC offerings.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.


marker
String marker
An optional pagination token provided by a previous
 DescribeOrderableDBInstanceOptions request. If this parameter is
 specified, the response includes only records beyond the marker, up to
 the value specified by MaxRecords .








Class com.amazonaws.services.rds.model.DescribeOrderableDBInstanceOptionsResult extends Object implements Serializable




Serialized Fields


orderableDBInstanceOptions
com.amazonaws.internal.ListWithAutoConstructFlag<T> orderableDBInstanceOptions
An OrderableDBInstanceOption structure containing information
 about orderable options for the DB instance.


marker
String marker
An optional pagination token provided by a previous
 OrderableDBInstanceOptions request. If this parameter is specified,
 the response includes only records beyond the marker, up to the value
 specified by MaxRecords .








Class com.amazonaws.services.rds.model.DescribePendingMaintenanceActionsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceIdentifier
String resourceIdentifier
The ARN of a resource to return pending maintenance actions for.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
A filter that specifies one or more resources to return pending
 maintenance actions for. 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.
 


marker
String marker
An optional pagination token provided by a previous
 DescribePendingMaintenanceActions request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to a number of records specified by
 MaxRecords.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more
 records exist than the specified 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.








Class com.amazonaws.services.rds.model.DescribePendingMaintenanceActionsResult extends Object implements Serializable




Serialized Fields


pendingMaintenanceActions
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActions
A list of the pending maintenance actions for the resource.


marker
String marker
An optional pagination token provided by a previous
 DescribePendingMaintenanceActions request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to a number of records specified by
 MaxRecords.








Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


reservedDBInstancesOfferingId
String reservedDBInstancesOfferingId
The offering identifier filter value. Specify this parameter to show
 only the available offering that matches the specified reservation
 identifier. Example:
 438012d3-4052-4cc7-b2e3-8d3372e0e706


dBInstanceClass
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show
 only the available offerings matching the specified DB instance class.


duration
String duration
Duration filter value, specified in years or seconds. Specify this
 parameter to show only reservations for this duration. Valid
 Values: 1 | 3 | 31536000 | 94608000


productDescription
String productDescription
Product description filter value. Specify this parameter to show only
 the available offerings matching the specified product description.


offeringType
String offeringType
The offering type filter value. Specify this parameter to show only
 the available offerings matching the specified offering type. Valid
 Values: "Partial Upfront" | "All Upfront" | "No Upfront" 


multiAZ
Boolean multiAZ
The Multi-AZ filter value. Specify this parameter to show only the
 available offerings matching the specified Multi-AZ parameter.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more than
 the 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.


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesOfferingsResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


reservedDBInstancesOfferings
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstancesOfferings
A list of reserved DB instance offerings.








Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


reservedDBInstanceId
String reservedDBInstanceId
The reserved DB instance identifier filter value. Specify this
 parameter to show only the reservation that matches the specified
 reservation ID.


reservedDBInstancesOfferingId
String reservedDBInstancesOfferingId
The offering identifier filter value. Specify this parameter to show
 only purchased reservations matching the specified offering
 identifier.


dBInstanceClass
String dBInstanceClass
The DB instance class filter value. Specify this parameter to show
 only those reservations matching the specified DB instances class.


duration
String duration
The duration filter value, specified in years or seconds. Specify this
 parameter to show only reservations for this duration. Valid
 Values: 1 | 3 | 31536000 | 94608000


productDescription
String productDescription
The product description filter value. Specify this parameter to show
 only those reservations matching the specified product description.


offeringType
String offeringType
The offering type filter value. Specify this parameter to show only
 the available offerings matching the specified offering type. Valid
 Values: "Partial Upfront" | "All Upfront" | "No Upfront" 


multiAZ
Boolean multiAZ
The Multi-AZ filter value. Specify this parameter to show only those
 reservations matching the specified Multi-AZ parameter.


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.


maxRecords
Integer maxRecords
The maximum number of records to include in the response. If more than
 the 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.


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.








Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesResult extends Object implements Serializable




Serialized Fields


marker
String marker
An optional pagination token provided by a previous request. If this
 parameter is specified, the response includes only records beyond the
 marker, up to the value specified by MaxRecords.


reservedDBInstances
com.amazonaws.internal.ListWithAutoConstructFlag<T> reservedDBInstances
A list of reserved DB instances.








Class com.amazonaws.services.rds.model.DomainMembership extends Object implements Serializable




Serialized Fields


domain
String domain
The identifier of the Active Directory Domain.


status
String status
The status of the DB instance's Active Directory Domain membership,
 such as joined, pending-join, failed etc).


fQDN
String fQDN
The fully qualified domain name of the Active Directory Domain.


iAMRoleName
String iAMRoleName
The name of the IAM role to be used when making API calls to the
 Directory Service.








Class com.amazonaws.services.rds.model.DomainNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.DownloadDBLogFilePortionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The customer-assigned name of the DB instance that contains the log
 files you want to list. Constraints: 
 Must contain from 1
 to 63 alphanumeric characters or hyphens
 First character must
 be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 


logFileName
String logFileName
The name of the log file to be downloaded.


marker
String marker
The pagination token provided in the previous request or "0". If the
 Marker parameter is specified the response includes only records
 beyond the marker until the end of the file or up to NumberOfLines.


numberOfLines
Integer numberOfLines
The number of lines to download. If the number of lines specified
 results in a file over 1 MB in size, the file will be truncated at 1
 MB in size. 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 up to a maximum of 10000 lines, starting
 with the most recent log entries first.
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.








Class com.amazonaws.services.rds.model.DownloadDBLogFilePortionResult extends Object implements Serializable




Serialized Fields


logFileData
String logFileData
Entries from the specified log file.


marker
String marker
A pagination token that can be used in a subsequent
 DownloadDBLogFilePortion request.


additionalDataPending
Boolean additionalDataPending
Boolean value that if true, indicates there is more data to be
 downloaded.








Class com.amazonaws.services.rds.model.EC2SecurityGroup extends Object implements Serializable




Serialized Fields


status
String status
Provides the status of the EC2 security group. Status can be
 "authorizing", "authorized", "revoking", and "revoked".


eC2SecurityGroupName
String eC2SecurityGroupName
Specifies the name of the EC2 security group.


eC2SecurityGroupId
String eC2SecurityGroupId
Specifies the id of the EC2 security group.


eC2SecurityGroupOwnerId
String eC2SecurityGroupOwnerId
Specifies the AWS ID of the owner of the EC2 security group specified
 in the EC2SecurityGroupName field.








Class com.amazonaws.services.rds.model.Endpoint extends Object implements Serializable




Serialized Fields


address
String address
Specifies the DNS address of the DB instance.


port
Integer port
Specifies the port that the database engine is listening on.


hostedZoneId
String hostedZoneId
Specifies the ID that Amazon Route 53 assigns when you create a hosted
 zone.








Class com.amazonaws.services.rds.model.EngineDefaults extends Object implements Serializable




Serialized Fields


dBParameterGroupFamily
String dBParameterGroupFamily
Specifies the name of the DB parameter group family that the engine
 default parameters apply to.


marker
String marker
An optional pagination token provided by a previous EngineDefaults
 request. If this parameter is specified, the response includes only
 records beyond the marker, up to the value specified by
 MaxRecords .


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
Contains a list of engine default parameters.








Class com.amazonaws.services.rds.model.Event extends Object implements Serializable




Serialized Fields


sourceIdentifier
String sourceIdentifier
Provides the identifier for the source of the event.


sourceType
String sourceType
Specifies the source type for this event.
 
 Constraints:

 Allowed Values: db-instance, db-parameter-group, db-security-group, db-snapshot, db-cluster, db-cluster-snapshot


message
String message
Provides the text of this event.


eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
Specifies the category for the event.


date
Date date
Specifies the date and time of the event.








Class com.amazonaws.services.rds.model.EventCategoriesMap extends Object implements Serializable




Serialized Fields


sourceType
String sourceType
The source type that the returned categories belong to


eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
The event categories for the specified source type








Class com.amazonaws.services.rds.model.EventSubscription extends Object implements Serializable




Serialized Fields


customerAwsId
String customerAwsId
The AWS customer account associated with the RDS event notification
 subscription.


custSubscriptionId
String custSubscriptionId
The RDS event notification subscription Id.


snsTopicArn
String snsTopicArn
The topic ARN of the RDS event notification subscription.


status
String status
The status of the RDS event notification subscription. 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.


subscriptionCreationTime
String subscriptionCreationTime
The time the RDS event notification subscription was created.


sourceType
String sourceType
The source type for the RDS event notification subscription.


sourceIdsList
com.amazonaws.internal.ListWithAutoConstructFlag<T> sourceIdsList
A list of source IDs for the RDS event notification subscription.


eventCategoriesList
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategoriesList
A list of event categories for the RDS event notification
 subscription.


enabled
Boolean enabled
A Boolean value indicating if the subscription is enabled. True
 indicates the subscription is enabled.








Class com.amazonaws.services.rds.model.EventSubscriptionQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.FailoverDBClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier
A DB cluster identifier to force a failover for. This parameter is not
 case-sensitive. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 








Class com.amazonaws.services.rds.model.Filter extends Object implements Serializable




Serialized Fields


name
String name
This parameter is not currently supported.


values
com.amazonaws.internal.ListWithAutoConstructFlag<T> values
This parameter is not currently supported.








Class com.amazonaws.services.rds.model.InstanceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InsufficientDBClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InsufficientStorageClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBClusterSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBClusterStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBInstanceStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBParameterGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBSecurityGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBSubnetGroupException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBSubnetGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidDBSubnetStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidEventSubscriptionStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidOptionGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidRestoreException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.IPRange extends Object implements Serializable




Serialized Fields


status
String status
Specifies the status of the IP range. Status can be "authorizing",
 "authorized", "revoking", and "revoked".


cIDRIP
String cIDRIP
Specifies the IP range.








Class com.amazonaws.services.rds.model.KMSKeyNotAccessibleException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceName
String resourceName
The Amazon RDS resource with tags to be listed. This value is an
 Amazon Resource Name (ARN). For information about creating an ARN, see
 
 Constructing an RDS Amazon Resource Name (ARN).


filters
com.amazonaws.internal.ListWithAutoConstructFlag<T> filters
This parameter is not currently supported.








Class com.amazonaws.services.rds.model.ListTagsForResourceResult extends Object implements Serializable




Serialized Fields


tagList
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagList
List of tags returned by the ListTagsForResource operation.








Class com.amazonaws.services.rds.model.ModifyDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group to modify.


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
A list of parameters in the DB cluster parameter group to modify.








Class com.amazonaws.services.rds.model.ModifyDBClusterParameterGroupResult extends Object implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group.  Constraints: 

 Must be 1 to 255 alphanumeric characters
 First character
 must be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 
 This value is stored as a
 lowercase string.








Class com.amazonaws.services.rds.model.ModifyDBClusterRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier
The DB cluster identifier for the cluster being modified. This
 parameter is not case-sensitive. Constraints: 
 Must be the
 identifier for an existing DB cluster.
 Must contain from 1 to
 63 alphanumeric characters or hyphens.
 First character must
 be a letter.
 Cannot end with a hyphen or contain two
 consecutive hyphens.
 


newDBClusterIdentifier
String newDBClusterIdentifier
The new DB cluster identifier for the DB cluster when renaming a DB
 cluster. This value is stored as a lowercase string. Constraints:
 
 Must contain from 1 to 63 alphanumeric characters or
 hyphens
 First character must be a letter
 Cannot end
 with a hyphen or contain two consecutive hyphens
 
 Example: my-cluster2


applyImmediately
Boolean applyImmediately
A value that specifies whether the modifications in this request and
 any pending modifications are asynchronously applied as soon as
 possible, regardless of the 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. The ApplyImmediately
 parameter only affects the NewDBClusterIdentifier and
 MasterUserPassword values. If you set the
 ApplyImmediately parameter value to false, then changes
 to the NewDBClusterIdentifier and
 MasterUserPassword values are applied during the next
 maintenance window. All other changes are applied immediately,
 regardless of the value of the ApplyImmediately
 parameter. 
Default: false


backupRetentionPeriod
Integer backupRetentionPeriod
The number of days for which automated backups are retained. You must
 specify a minimum value of 1. Default: 1 
Constraints: 

 Must be a value from 1 to 35
 


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group to use for the DB cluster.


vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
A lst of VPC security groups that the DB cluster will belong to.


port
Integer port
The port number on which the DB cluster accepts connections.
 Constraints: Value must be 1150-65535 
Default: The
 same port as the original DB cluster.


masterUserPassword
String masterUserPassword
The new password for the master database user. This password can
 contain any printable ASCII character except "/", """, or "@".
 Constraints: Must contain from 8 to 41 characters.


optionGroupName
String optionGroupName
A value that indicates that the DB cluster should be associated with
 the specified option group. Changing this parameter does not result in
 an outage except in the following case, and the change is applied
 during the next maintenance window unless the
 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.


preferredBackupWindow
String preferredBackupWindow
The daily time range during which automated backups are created if
 automated backups are enabled, using the
 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: 
 Must be in the format
 hh24:mi-hh24:mi.
 Times should be in Universal
 Coordinated Time (UTC).
 Must not conflict with the preferred
 maintenance window.
 Must be at least 30 minutes.
 


preferredMaintenanceWindow
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in
 Universal Coordinated Time (UTC).  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.








Class com.amazonaws.services.rds.model.ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The DB instance identifier. This value is stored as a lowercase
 string. Constraints: 
 Must be the identifier for an
 existing DB instance
 Must contain from 1 to 63 alphanumeric
 characters or hyphens
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 


allocatedStorage
Integer allocatedStorage
The new storage capacity of the RDS instance. Changing this setting
 does not result in an outage and the change is applied during the next
 maintenance window unless 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.


dBInstanceClass
String dBInstanceClass
The new compute and memory capacity of the DB instance. To determine
 the instance classes that are available for a particular DB engine,
 use the DescribeOrderableDBInstanceOptions action.  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


dBSecurityGroups
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroups
A list of DB security groups to authorize on this DB instance.
 Changing this setting does not result in an outage and the change is
 asynchronously applied as soon as possible. Constraints: 

 Must be 1 to 255 alphanumeric characters
 First character
 must be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 


vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
A list of EC2 VPC security groups to authorize on this DB instance.
 This change is asynchronously applied as soon as possible.
 Constraints: 
 Must be 1 to 255 alphanumeric characters
 First character must be a letter
 Cannot end with a hyphen
 or contain two consecutive hyphens
 


applyImmediately
Boolean applyImmediately
Specifies whether the modifications in this request and any pending
 modifications are asynchronously applied as soon as possible,
 regardless of the 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


masterUserPassword
String masterUserPassword
The new password for the DB instance master user. Can be any printable
 ASCII character except "/", """, or "@".  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).  Amazon RDS API actions
 never return the password, so this action provides a way to regain
 access to a primary instance user if the password is lost. This
 includes restoring privileges that might have been accidentally
 revoked. 


dBParameterGroupName
String dBParameterGroupName
The name of the DB parameter group to apply to the DB instance.
 Changing this setting does not result in an outage. The parameter
 group name itself is changed immediately, but the actual parameter
 changes are not applied until you reboot the instance without
 failover. The db instance will NOT be rebooted automatically and the
 parameter changes will NOT be applied during the next maintenance
 window. Default: Uses existing setting 
Constraints: The DB
 parameter group must be in the same DB parameter group family as this
 DB instance.


backupRetentionPeriod
Integer backupRetentionPeriod
The number of days to retain automated backups. Setting this parameter
 to a positive number enables backups. Setting this parameter to 0
 disables automated backups. 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: 
 Must be a value from 0 to 35
 Can be specified for a MySQL Read Replica only if the source is
 running MySQL 5.6
 Can be specified for a PostgreSQL Read
 Replica only if the source is running PostgreSQL 9.3.5
 Cannot
 be set to 0 if the DB instance is a source to Read Replicas
 


preferredBackupWindow
String preferredBackupWindow
The daily time range during which automated backups are created if
 automated backups are enabled, as determined by the
 BackupRetentionPeriod parameter. Changing this parameter
 does not result in an outage and the change is asynchronously applied
 as soon as possible. Constraints: 
 Must be in the format
 hh24:mi-hh24:mi
 Times should be in Universal Time Coordinated
 (UTC)
 Must not conflict with the preferred maintenance
 window
 Must be at least 30 minutes
 


preferredMaintenanceWindow
String preferredMaintenanceWindow
The weekly time range (in UTC) during which system maintenance can
 occur, which might result in an outage. Changing this parameter does
 not result in an outage, except in the following situation, and the
 change is asynchronously applied as soon as possible. If there are
 pending actions that cause a reboot, and the maintenance window is
 changed to include the current time, then changing this parameter will
 cause a reboot of the DB instance. If moving this window to the
 current time, there must be at least 30 minutes between the current
 time and end of the window to ensure pending changes are applied.
 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


multiAZ
Boolean multiAZ
Specifies if the DB instance is a Multi-AZ deployment. Changing this
 parameter does not result in an outage and the change is applied
 during the next maintenance window unless the
 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.


engineVersion
String engineVersion
The version number of the database engine to upgrade to. Changing this
 parameter results in an outage and the change is applied during the
 next maintenance window unless the 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.


allowMajorVersionUpgrade
Boolean allowMajorVersionUpgrade
Indicates that major version upgrades are allowed. Changing this
 parameter does not result in an outage and the change is
 asynchronously applied as soon as possible. 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.


autoMinorVersionUpgrade
Boolean autoMinorVersionUpgrade
Indicates that minor version upgrades will be applied automatically to
 the DB instance during the maintenance window. Changing this parameter
 does not result in an outage except in the following case and the
 change is asynchronously applied as soon as possible. An outage will
 result if this parameter is set to true during the
 maintenance window, and a newer minor version is available, and RDS
 has enabled auto patching for that engine version.


iops
Integer iops
The new Provisioned IOPS (I/O operations per second) value for the RDS
 instance. Changing this setting does not result in an outage and the
 change is applied during the next maintenance window unless the
 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.


optionGroupName
String optionGroupName
Indicates that the DB instance should be associated with the specified
 option group. Changing this parameter does not result in an outage
 except in the following case and the change is applied during the next
 maintenance window unless the 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


newDBInstanceIdentifier
String newDBInstanceIdentifier
The new DB instance identifier for the DB instance when renaming a DB
 instance. When you change the DB instance identifier, an instance
 reboot will occur immediately if you set 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: 
 Must contain
 from 1 to 63 alphanumeric characters or hyphens
 First
 character must be a letter
 Cannot end with a hyphen or
 contain two consecutive hyphens
 


storageType
String storageType
Specifies the storage type to be associated with the DB instance. 
 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


tdeCredentialArn
String tdeCredentialArn
The ARN from the Key Store with which to associate the instance for
 TDE encryption.


tdeCredentialPassword
String tdeCredentialPassword
The password for the given ARN from the Key Store in order to access
 the device.


cACertificateIdentifier
String cACertificateIdentifier
Indicates the certificate that needs to be associated with the
 instance.


domain
String domain
Specify the Active Directory Domain to move the instance to. The
 specified Active Directory Domain must be created prior to this
 operation. Currently only a SQL Server instance can be created in a
 Active Directory Domain.


copyTagsToSnapshot
Boolean copyTagsToSnapshot
True to copy all tags from the DB instance to snapshots of the DB
 instance; otherwise false. The default is false.


monitoringInterval
Integer monitoringInterval
The interval, in seconds, between points when Enhanced Monitoring
 metrics are collected for the DB instance. To disable collecting
 Enhanced Monitoring metrics, specify 0. The default is 60. 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


dBPortNumber
Integer dBPortNumber
The port number on which the database accepts connections. 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 
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


publiclyAccessible
Boolean publiclyAccessible
Boolean value that indicates if the DB instance has a publicly
 resolvable DNS name. Set to True to make the DB instance
 Internet-facing with a publicly resolvable DNS name, which resolves to
 a public IP address. Set to False to make the DB instance
 internal with a DNS name that resolves to a private IP address.
 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


monitoringRoleArn
String monitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring
 metrics to CloudWatch Logs. For example,
 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.


domainIAMRoleName
String domainIAMRoleName
Specify the name of the IAM role to be used when making API calls to
 the Directory Service.


promotionTier
Integer promotionTier
A value that specifies the order in which an Aurora Replica is
 promoted to the primary instance after a failure of the existing
 primary instance. For more information, see 
 Fault Tolerance for an Aurora DB Cluster. Default: 1 
Valid
 Values: 0 - 15








Class com.amazonaws.services.rds.model.ModifyDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
The name of the DB parameter group. Constraints: 
 Must be
 the name of an existing DB parameter group
 Must be 1 to 255
 alphanumeric characters
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
An array of parameter names, values, and the apply method for the
 parameter update. At least one parameter name, value, and apply method
 must be supplied; subsequent arguments are optional. A maximum of 20
 parameters can be modified in a single request. Valid Values (for
 the application 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 you reboot the DB instance
 without failover. 








Class com.amazonaws.services.rds.model.ModifyDBParameterGroupResult extends Object implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
Provides the name of the DB parameter group.








Class com.amazonaws.services.rds.model.ModifyDBSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSnapshotIdentifier
String dBSnapshotIdentifier
The identifier for the DB snapshot to modify the attributes for.


attributeName
String attributeName
The name of the DB snapshot attribute to modify. To manage
 authorization for other AWS accounts to copy or restore a manual DB
 snapshot, this value is restore.


valuesToAdd
com.amazonaws.internal.ListWithAutoConstructFlag<T> valuesToAdd
A list of DB snapshot attributes to add to the attribute specified by
 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.


valuesToRemove
com.amazonaws.internal.ListWithAutoConstructFlag<T> valuesToRemove
A list of DB snapshot attributes to remove from the attribute
 specified by 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.








Class com.amazonaws.services.rds.model.ModifyDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBSubnetGroupName
String dBSubnetGroupName
The name for the DB subnet group. This value is stored as a lowercase
 string. Constraints: Must contain no more than 255 alphanumeric
 characters, periods, underscores, spaces, or hyphens. Must not be
 default. 
Example: mySubnetgroup


dBSubnetGroupDescription
String dBSubnetGroupDescription
The description for the DB subnet group.


subnetIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> subnetIds
The EC2 subnet IDs for the DB subnet group.








Class com.amazonaws.services.rds.model.ModifyEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


subscriptionName
String subscriptionName
The name of the RDS event notification subscription.


snsTopicArn
String snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event
 notification. The ARN is created by Amazon SNS when you create a topic
 and subscribe to it.


sourceType
String sourceType
The type of source that will be generating the events. For example, if
 you want to be notified of events generated by a DB instance, you
 would set this parameter to db-instance. if this value is not
 specified, all events are returned. Valid values: db-instance |
 db-parameter-group | db-security-group | db-snapshot


eventCategories
com.amazonaws.internal.ListWithAutoConstructFlag<T> eventCategories
A list of event categories for a SourceType that you want to subscribe
 to. You can see a list of the categories for a given SourceType in the
 Events
 topic in the Amazon RDS User Guide or by using the
 DescribeEventCategories action.


enabled
Boolean enabled
A Boolean value; set to true to activate the subscription.








Class com.amazonaws.services.rds.model.ModifyOptionGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


optionGroupName
String optionGroupName
The name of the option group to be modified.  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


optionsToInclude
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToInclude
Options in this list are added to the option group or, if already
 present, the specified configuration is used to update the existing
 configuration.


optionsToRemove
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsToRemove
Options in this list are removed from the option group.


applyImmediately
Boolean applyImmediately
Indicates whether the changes should be applied immediately, or during
 the next maintenance window for each instance associated with the
 option group.








Class com.amazonaws.services.rds.model.Option extends Object implements Serializable




Serialized Fields


optionName
String optionName
The name of the option.


optionDescription
String optionDescription
The description of the option.


persistent
Boolean persistent
Indicate if this option is persistent.


permanent
Boolean permanent
Indicate if this option is permanent.


port
Integer port
If required, the port configured for this option to use.


optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
The option settings for this option.


dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
If the option requires access to a port, then this DB security group
 allows access to the port.


vpcSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
If the option requires access to a port, then this VPC security group
 allows access to the port.








Class com.amazonaws.services.rds.model.OptionConfiguration extends Object implements Serializable




Serialized Fields


optionName
String optionName
The configuration of options to include in a group.


port
Integer port
The optional port for the option.


dBSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> dBSecurityGroupMemberships
A list of DBSecurityGroupMemebrship name strings used for this option.


vpcSecurityGroupMemberships
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupMemberships
A list of VpcSecurityGroupMemebrship name strings used for this
 option.


optionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionSettings
The option settings to include in an option group.








Class com.amazonaws.services.rds.model.OptionGroup extends Object implements Serializable




Serialized Fields


optionGroupName
String optionGroupName
Specifies the name of the option group.


optionGroupDescription
String optionGroupDescription
Provides a description of the option group.


engineName
String engineName
Indicates the name of the engine that this option group can be applied
 to.


majorEngineVersion
String majorEngineVersion
Indicates the major engine version associated with this option group.


options
com.amazonaws.internal.ListWithAutoConstructFlag<T> options
Indicates what options are available in the option group.


allowsVpcAndNonVpcInstanceMemberships
Boolean allowsVpcAndNonVpcInstanceMemberships
Indicates whether this option group can be applied to both VPC and
 non-VPC instances. The value true indicates the option
 group can be applied to both VPC and non-VPC instances.


vpcId
String vpcId
If AllowsVpcAndNonVpcInstanceMemberships is 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.








Class com.amazonaws.services.rds.model.OptionGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.OptionGroupMembership extends Object implements Serializable




Serialized Fields


optionGroupName
String optionGroupName
The name of the option group that the instance belongs to.


status
String status
The status of the DB instance's option group membership. Valid values
 are: in-sync, pending-apply,
 pending-removal, pending-maintenance-apply,
 pending-maintenance-removal, applying,
 removing, and failed.








Class com.amazonaws.services.rds.model.OptionGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.OptionGroupOption extends Object implements Serializable




Serialized Fields


name
String name
The name of the option.


description
String description
The description of the option.


engineName
String engineName
The name of the engine that this option can be applied to.


majorEngineVersion
String majorEngineVersion
Indicates the major engine version that the option is available for.


minimumRequiredMinorEngineVersion
String minimumRequiredMinorEngineVersion
The minimum required engine version for the option to be applied.


portRequired
Boolean portRequired
Specifies whether the option requires a port.


defaultPort
Integer defaultPort
If the option requires a port, specifies the default port for the
 option.


optionsDependedOn
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionsDependedOn
List of all options that are prerequisites for this option.


persistent
Boolean persistent
A persistent option cannot be removed from the option group once the
 option group is used, but this option can be removed from the db
 instance while modifying the related data and assigning another option
 group without this option.


permanent
Boolean permanent
A permanent option cannot be removed from the option group once the
 option group is used, and it cannot be removed from the db instance
 after assigning an option group with this permanent option.


optionGroupOptionSettings
com.amazonaws.internal.ListWithAutoConstructFlag<T> optionGroupOptionSettings
Specifies the option settings that are available (and the default
 value) for each option in an option group.








Class com.amazonaws.services.rds.model.OptionGroupOptionSetting extends Object implements Serializable




Serialized Fields


settingName
String settingName
The name of the option group option.


settingDescription
String settingDescription
The description of the option group option.


defaultValue
String defaultValue
The default value for the option group option.


applyType
String applyType
The DB engine specific parameter type for the option group option.


allowedValues
String allowedValues
Indicates the acceptable values for the option group option.


isModifiable
Boolean isModifiable
Boolean value where true indicates that this option group option can
 be changed from the default value.








Class com.amazonaws.services.rds.model.OptionGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.OptionSetting extends Object implements Serializable




Serialized Fields


name
String name
The name of the option that has settings that you can set.


value
String value
The current value of the option setting.


defaultValue
String defaultValue
The default value of the option setting.


description
String description
The description of the option setting.


applyType
String applyType
The DB engine specific parameter type.


dataType
String dataType
The data type of the option setting.


allowedValues
String allowedValues
The allowed values of the option setting.


isModifiable
Boolean isModifiable
A Boolean value that, when true, indicates the option setting can be
 modified from the default.


isCollection
Boolean isCollection
Indicates if the option setting is part of a collection.








Class com.amazonaws.services.rds.model.OrderableDBInstanceOption extends Object implements Serializable




Serialized Fields


engine
String engine
The engine type of the orderable DB instance.


engineVersion
String engineVersion
The engine version of the orderable DB instance.


dBInstanceClass
String dBInstanceClass
The DB instance class for the orderable DB instance.


licenseModel
String licenseModel
The license model for the orderable DB instance.


availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
A list of Availability Zones for the orderable DB instance.


multiAZCapable
Boolean multiAZCapable
Indicates whether this orderable DB instance is multi-AZ capable.


readReplicaCapable
Boolean readReplicaCapable
Indicates whether this orderable DB instance can have a Read Replica.


vpc
Boolean vpc
Indicates whether this is a VPC orderable DB instance.


supportsStorageEncryption
Boolean supportsStorageEncryption
Indicates whether this orderable DB instance supports encrypted
 storage.


storageType
String storageType
Indicates the storage type for this orderable DB instance.


supportsIops
Boolean supportsIops
Indicates whether this orderable DB instance supports provisioned
 IOPS.


supportsEnhancedMonitoring
Boolean supportsEnhancedMonitoring
Indicates whether the DB instance supports enhanced monitoring at
 intervals from 1 to 60 seconds.








Class com.amazonaws.services.rds.model.Parameter extends Object implements Serializable




Serialized Fields


parameterName
String parameterName
Specifies the name of the parameter.


parameterValue
String parameterValue
Specifies the value of the parameter.


description
String description
Provides a description of the parameter.


source
String source
Indicates the source of the parameter value.


applyType
String applyType
Specifies the engine specific parameters type.


dataType
String dataType
Specifies the valid data type for the parameter.


allowedValues
String allowedValues
Specifies the valid range of values for the parameter.


isModifiable
Boolean isModifiable
Indicates whether (true) or not (false) the
 parameter can be modified. Some parameters have security or
 operational implications that prevent them from being changed.


minimumEngineVersion
String minimumEngineVersion
The earliest engine version to which the parameter can apply.


applyMethod
String applyMethod
Indicates when to apply parameter updates.
 
 Constraints:

 Allowed Values: immediate, pending-reboot








Class com.amazonaws.services.rds.model.PendingMaintenanceAction extends Object implements Serializable




Serialized Fields


action
String action
The type of pending maintenance action that is available for the
 resource.


autoAppliedAfterDate
Date autoAppliedAfterDate
The date of the maintenance window when the action will be applied.
 The maintenance action will be applied to the resource during its
 first maintenance window after this date. If this date is specified,
 any next-maintenance opt-in requests are ignored.


forcedApplyDate
Date forcedApplyDate
The date when the maintenance action will be automatically applied.
 The maintenance action will be applied to the resource on this date
 regardless of the maintenance window for the resource. If this date is
 specified, any immediate opt-in requests are ignored.


optInStatus
String optInStatus
Indicates the type of opt-in request that has been received for the
 resource.


currentApplyDate
Date currentApplyDate
The effective date when the pending maintenance action will be applied
 to the resource. This date takes into account opt-in requests received
 from the ApplyPendingMaintenanceAction API, the
 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.


description
String description
A description providing more detail about the maintenance action.








Class com.amazonaws.services.rds.model.PendingModifiedValues extends Object implements Serializable




Serialized Fields


dBInstanceClass
String dBInstanceClass
Contains the new DBInstanceClass for the DB instance that
 will be applied or is in progress.


allocatedStorage
Integer allocatedStorage
Contains the new AllocatedStorage size for the DB
 instance that will be applied or is in progress.


masterUserPassword
String masterUserPassword
Contains the pending or in-progress change of the master credentials
 for the DB instance.


port
Integer port
Specifies the pending port for the DB instance.


backupRetentionPeriod
Integer backupRetentionPeriod
Specifies the pending number of days for which automated backups are
 retained.


multiAZ
Boolean multiAZ
Indicates that the Single-AZ DB instance is to change to a Multi-AZ
 deployment.


engineVersion
String engineVersion
Indicates the database engine version.


iops
Integer iops
Specifies the new Provisioned IOPS value for the DB instance that will
 be applied or is being applied.


dBInstanceIdentifier
String dBInstanceIdentifier
Contains the new DBInstanceIdentifier for the DB instance
 that will be applied or is in progress.


storageType
String storageType
Specifies the storage type to be associated with the DB instance.


cACertificateIdentifier
String cACertificateIdentifier
Specifies the identifier of the CA certificate for the DB instance.








Class com.amazonaws.services.rds.model.PointInTimeRestoreNotEnabledException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.PromoteReadReplicaRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The DB instance identifier. This value is stored as a lowercase
 string. Constraints: 
 Must be the identifier for an
 existing Read Replica DB instance
 Must contain from 1 to 63
 alphanumeric characters or hyphens
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 
 Example: mydbinstance


backupRetentionPeriod
Integer backupRetentionPeriod
The number of days to retain automated backups. Setting this parameter
 to a positive number enables backups. Setting this parameter to 0
 disables automated backups.  Default: 1 
Constraints: 

 Must be a value from 0 to 8
 


preferredBackupWindow
String preferredBackupWindow
The daily time range during which automated backups are created if
 automated backups are enabled, using the
 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: 
 Must be in the format
 hh24:mi-hh24:mi.
 Times should be in Universal
 Coordinated Time (UTC).
 Must not conflict with the preferred
 maintenance window.
 Must be at least 30 minutes.
 








Class com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.PurchaseReservedDBInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


reservedDBInstancesOfferingId
String reservedDBInstancesOfferingId
The ID of the Reserved DB instance offering to purchase. Example:
 438012d3-4052-4cc7-b2e3-8d3372e0e706


reservedDBInstanceId
String reservedDBInstanceId
Customer-specified identifier to track this reservation. Example:
 myreservationID


dBInstanceCount
Integer dBInstanceCount
The number of instances to reserve. Default: 1


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.








Class com.amazonaws.services.rds.model.RebootDBInstanceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBInstanceIdentifier
String dBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase
 string. Constraints: 
 Must contain from 1 to 63
 alphanumeric characters or hyphens
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 


forceFailover
Boolean forceFailover
When true, the reboot will be conducted through a MultiAZ
 failover. Constraint: You cannot specify true if the
 instance is not configured for MultiAZ.








Class com.amazonaws.services.rds.model.RecurringCharge extends Object implements Serializable




Serialized Fields


recurringChargeAmount
Double recurringChargeAmount
The amount of the recurring charge.


recurringChargeFrequency
String recurringChargeFrequency
The frequency of the recurring charge.








Class com.amazonaws.services.rds.model.RemoveSourceIdentifierFromSubscriptionRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


subscriptionName
String subscriptionName
The name of the RDS event notification subscription you want to remove
 a source identifier from.


sourceIdentifier
String sourceIdentifier
The source identifier to be removed from the subscription, such as the
 DB instance identifier for a DB instance or the name of a
 security group.








Class com.amazonaws.services.rds.model.RemoveTagsFromResourceRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


resourceName
String resourceName
The Amazon RDS resource the tags will be removed from. This value is
 an Amazon Resource Name (ARN). For information about creating an ARN,
 see 
 Constructing an RDS Amazon Resource Name (ARN).


tagKeys
com.amazonaws.internal.ListWithAutoConstructFlag<T> tagKeys
The tag key (name) of the tag to be removed.








Class com.amazonaws.services.rds.model.ReservedDBInstance extends Object implements Serializable




Serialized Fields


reservedDBInstanceId
String reservedDBInstanceId
The unique identifier for the reservation.


reservedDBInstancesOfferingId
String reservedDBInstancesOfferingId
The offering identifier.


dBInstanceClass
String dBInstanceClass
The DB instance class for the reserved DB instance.


startTime
Date startTime
The time the reservation started.


duration
Integer duration
The duration of the reservation in seconds.


fixedPrice
Double fixedPrice
The fixed price charged for this reserved DB instance.


usagePrice
Double usagePrice
The hourly price charged for this reserved DB instance.


currencyCode
String currencyCode
The currency code for the reserved DB instance.


dBInstanceCount
Integer dBInstanceCount
The number of reserved DB instances.


productDescription
String productDescription
The description of the reserved DB instance.


offeringType
String offeringType
The offering type of this reserved DB instance.


multiAZ
Boolean multiAZ
Indicates if the reservation applies to Multi-AZ deployments.


state
String state
The state of the reserved DB instance.


recurringCharges
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
The recurring price charged to run this reserved DB instance.








Class com.amazonaws.services.rds.model.ReservedDBInstanceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.ReservedDBInstanceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.ReservedDBInstanceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.ReservedDBInstancesOffering extends Object implements Serializable




Serialized Fields


reservedDBInstancesOfferingId
String reservedDBInstancesOfferingId
The offering identifier.


dBInstanceClass
String dBInstanceClass
The DB instance class for the reserved DB instance.


duration
Integer duration
The duration of the offering in seconds.


fixedPrice
Double fixedPrice
The fixed price charged for this offering.


usagePrice
Double usagePrice
The hourly price charged for this offering.


currencyCode
String currencyCode
The currency code for the reserved DB instance offering.


productDescription
String productDescription
The database engine used by the offering.


offeringType
String offeringType
The offering type.


multiAZ
Boolean multiAZ
Indicates if the offering applies to Multi-AZ deployments.


recurringCharges
com.amazonaws.internal.ListWithAutoConstructFlag<T> recurringCharges
The recurring price charged to run this reserved DB instance.








Class com.amazonaws.services.rds.model.ReservedDBInstancesOfferingNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.ResetDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group to reset.


resetAllParameters
Boolean resetAllParameters
A value that is set to 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.


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
A list of parameter names in the DB cluster parameter group to reset
 to the default values. You cannot use this parameter if the
 ResetAllParameters parameter is set to true.








Class com.amazonaws.services.rds.model.ResetDBClusterParameterGroupResult extends Object implements Serializable




Serialized Fields


dBClusterParameterGroupName
String dBClusterParameterGroupName
The name of the DB cluster parameter group.  Constraints: 

 Must be 1 to 255 alphanumeric characters
 First character
 must be a letter
 Cannot end with a hyphen or contain two
 consecutive hyphens
 
 This value is stored as a
 lowercase string.








Class com.amazonaws.services.rds.model.ResetDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
The name of the DB parameter group. Constraints: 
 Must be 1
 to 255 alphanumeric characters
 First character must be a
 letter
 Cannot end with a hyphen or contain two consecutive
 hyphens
 


resetAllParameters
Boolean resetAllParameters
Specifies whether (true) or not (false) to
 reset all parameters in the DB parameter group to default values.
 Default: true


parameters
com.amazonaws.internal.ListWithAutoConstructFlag<T> parameters
An array of parameter names, values, and the apply method for the
 parameter update. At least one parameter name, value, and apply method
 must be supplied; subsequent arguments are optional. A maximum of 20
 parameters can be modified in a single request.  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








Class com.amazonaws.services.rds.model.ResetDBParameterGroupResult extends Object implements Serializable




Serialized Fields


dBParameterGroupName
String dBParameterGroupName
Provides the name of the DB parameter group.








Class com.amazonaws.services.rds.model.ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:
1L





Class com.amazonaws.services.rds.model.ResourcePendingMaintenanceActions extends Object implements Serializable




Serialized Fields


resourceIdentifier
String resourceIdentifier
The ARN of the resource that has pending maintenance actions.


pendingMaintenanceActionDetails
com.amazonaws.internal.ListWithAutoConstructFlag<T> pendingMaintenanceActionDetails
A list that provides details about the pending maintenance actions for
 the resource.








Class com.amazonaws.services.rds.model.RestoreDBClusterFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


availabilityZones
com.amazonaws.internal.ListWithAutoConstructFlag<T> availabilityZones
Provides the list of EC2 Availability Zones that instances in the
 restored DB cluster can be created in.


dBClusterIdentifier
String dBClusterIdentifier
The name of the DB cluster to create from the DB cluster snapshot.
 This parameter isn't case-sensitive. Constraints: 
 Must
 contain from 1 to 255 alphanumeric characters or hyphens
 First character must be a letter
 Cannot end with a hyphen
 or contain two consecutive hyphens
 
 Example:
 my-snapshot-id


snapshotIdentifier
String snapshotIdentifier
The identifier for the DB cluster snapshot to restore from.
 Constraints: 
 Must contain from 1 to 63 alphanumeric
 characters or hyphens
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 


engine
String engine
The database engine to use for the new DB cluster. Default: The
 same as source 
Constraint: Must be compatible with the engine of
 the source


engineVersion
String engineVersion
The version of the database engine to use for the new DB cluster.


port
Integer port
The port number on which the new DB cluster accepts connections.
 Constraints: Value must be 1150-65535 
Default: The
 same port as the original DB cluster.


dBSubnetGroupName
String dBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
 Constraints: Must contain no more than 255 alphanumeric characters,
 periods, underscores, spaces, or hyphens. Must not be default.
 
Example: mySubnetgroup


databaseName
String databaseName
The database name for the restored DB cluster.


optionGroupName
String optionGroupName
The name of the option group to use for the restored DB cluster.


vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
The tags to be assigned to the restored DB cluster.


kmsKeyId
String kmsKeyId
The KMS key identifier to use when restoring an encrypted DB cluster
 from an encrypted DB cluster snapshot. 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 the DB cluster snapshot is
 encrypted, then the restored DB cluster is encrypted using the KMS key
 that was used to encrypt the DB cluster snapshot.
 If the DB
 cluster snapshot is not encrypted, then the restored DB cluster is not
 encrypted.
 
 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.








Class com.amazonaws.services.rds.model.RestoreDBClusterToPointInTimeRequest extends AmazonWebServiceRequest implements Serializable




Serialized Fields


dBClusterIdentifier
String dBClusterIdentifier
The name of the new DB cluster to be created. Constraints: 

 Must contain from 1 to 63 alphanumeric characters or hyphens
 First character must be a letter
 Cannot end with a hyphen
 or contain two consecutive hyphens
 


sourceDBClusterIdentifier
String sourceDBClusterIdentifier
The identifier of the source DB cluster from which to restore.
 Constraints: 
 Must be the identifier of an existing
 database instance
 Must contain from 1 to 63 alphanumeric
 characters or hyphens
 First character must be a letter
 Cannot end with a hyphen or contain two consecutive hyphens
 


restoreToTime
Date restoreToTime
The date and time to restore the DB cluster to. Valid Values: Value
 must be a time in Universal Coordinated Time (UTC) format
 
Constraints: 
 Must be before the latest restorable time for
 the DB instance
 Cannot be specified if
 UseLatestRestorableTime parameter is true
 
 Example: 2015-03-07T23:45:00Z


useLatestRestorableTime
Boolean useLatestRestorableTime
A value that is set to 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.


port
Integer port
The port number on which the new DB cluster accepts connections.
 Constraints: Value must be 1150-65535 
Default: The
 same port as the original DB cluster.


dBSubnetGroupName
String dBSubnetGroupName
The DB subnet group name to use for the new DB cluster.
 Constraints: Must contain no more than 255 alphanumeric characters,
 periods, underscores, spaces, or hyphens. Must not be default.
 
Example: mySubnetgroup


optionGroupName
String optionGroupName
The name of the option group for the new DB cluster.


vpcSecurityGroupIds
com.amazonaws.internal.ListWithAutoConstructFlag<T> vpcSecurityGroupIds
A lst of VPC security groups that the new DB cluster belongs to.


tags
com.amazonaws.internal.ListWithAutoConstructFlag<T> tags
A list of tags.


kmsKeyId
String kmsKeyId
The KMS key identifier to use when restoring an encrypted DB cluster
 from an encrypted DB cluster. 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 the DB cluster is encrypted, then the restored DB cluster
 is encrypted using the KMS key that was used to encrypt the source DB
 cluster.
 
 
If the DB cluster is not encrypted, then the
 restored DB cluster is not encrypted.
 If
 DBClusterIdentifier refers to a DB cluster that is note
 encrypted, then the restore request is rejected.

Did this page help you?

Serialized Form

Package com.amazonaws

Class com.amazonaws.AbortedException extends AmazonClientException implements Serializable

Class com.amazonaws.AmazonClientException extends RuntimeException implements Serializable

Class com.amazonaws.AmazonServiceException extends AmazonClientException implements Serializable

Serialized Fields

requestId

errorCode

errorType

errorMessage

statusCode

serviceName

rawResponse

Class com.amazonaws.ResetException extends AmazonClientException implements Serializable

Serialized Fields

extraInfo

Package com.amazonaws.http.exception

Class com.amazonaws.http.exception.HttpRequestTimeoutException extends IOException implements Serializable

Package com.amazonaws.http.timers.client

Class com.amazonaws.http.timers.client.ClientExecutionTimeoutException extends AmazonClientException implements Serializable

Class com.amazonaws.http.timers.client.SdkInterruptedException extends InterruptedException implements Serializable

Package com.amazonaws.services.apigateway.model

Class com.amazonaws.services.apigateway.model.ApiKey extends Object implements Serializable

Serialized Fields

id

name

description

enabled

stageKeys

createdDate

lastUpdatedDate

Class com.amazonaws.services.apigateway.model.Authorizer extends Object implements Serializable

Serialized Fields

id

name

type

authType

authorizerUri

authorizerCredentials

identitySource

identityValidationExpression

authorizerResultTtlInSeconds

Class com.amazonaws.services.apigateway.model.BadRequestException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.apigateway.model.BasePathMapping extends Object implements Serializable

Serialized Fields

basePath

restApiId

stage

Class com.amazonaws.services.apigateway.model.ClientCertificate extends Object implements Serializable

Serialized Fields

clientCertificateId

description

pemEncodedCertificate

createdDate

expirationDate

Class com.amazonaws.services.apigateway.model.ConflictException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.apigateway.model.CreateApiKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

description

enabled

stageKeys

Class com.amazonaws.services.apigateway.model.CreateApiKeyResult extends Object implements Serializable

Serialized Fields

id

name

description

enabled

stageKeys

createdDate

lastUpdatedDate

Class com.amazonaws.services.apigateway.model.CreateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

restApiId

name

type

authType

authorizerUri

authorizerCredentials