Serialized Form

Package com.amazonaws

Exception Class com.amazonaws.AbortedException

class AbortedException extends AmazonClientException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.AmazonClientException

class AmazonClientException extends RuntimeException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.AmazonServiceException

class AmazonServiceException extends AmazonClientException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

The AWS error code represented by this exception (ex: InvalidParameterValue).

errorMessage

String errorMessage

The error message as returned by the service.

errorType

AmazonServiceException.ErrorType errorType

Indicates (if known) whether this exception was the fault of the caller or the service.

See Also:

• AmazonServiceException.ErrorType

rawResponse

byte[] rawResponse

The raw response payload.

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.

serviceName

String serviceName

The name of the Amazon service that sent this error response.

statusCode

int statusCode

The HTTP status code that was returned with this error

Exception Class com.amazonaws.ResetException

class ResetException extends AmazonClientException implements Serializable

serialVersionUID:

1L

Serialized Fields

extraInfo

String extraInfo

Package com.amazonaws.http.exception

Exception Class com.amazonaws.http.exception.HttpRequestTimeoutException

class HttpRequestTimeoutException extends IOException implements Serializable

serialVersionUID:

-2588353895012259837L

Package com.amazonaws.http.timers.client

Exception Class com.amazonaws.http.timers.client.ClientExecutionTimeoutException

class ClientExecutionTimeoutException extends AmazonClientException implements Serializable

serialVersionUID:

4861767589924758934L

Exception Class com.amazonaws.http.timers.client.SdkInterruptedException

class SdkInterruptedException extends InterruptedException implements Serializable

serialVersionUID:

8194951388566545094L

Package com.amazonaws.protocol.json

Exception Class com.amazonaws.protocol.json.SdkJsonGenerator.JsonGenerationException

class JsonGenerationException extends AmazonClientException implements Serializable

Package com.amazonaws.services.apigateway.model

Class com.amazonaws.services.apigateway.model.ApiKey

class ApiKey extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API Key was created, in ISO 8601 format.

description

String description

The description of the API Key.

enabled

Boolean enabled

Specifies whether the API Key can be used by callers.

id

String id

The identifier of the API Key.

lastUpdatedDate

Date lastUpdatedDate

When the API Key was last updated, in ISO 8601 format.

name

String name

The name of the API Key.

stageKeys

List<String> stageKeys

A list of Stage resources that are associated with the ApiKey resource.

Class com.amazonaws.services.apigateway.model.Authorizer

class Authorizer extends Object implements Serializable

Serialized Fields

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.

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.

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

authType

String authType

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

id

String id

The identifier for the authorizer resource.

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.

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.

Exception Class com.amazonaws.services.apigateway.model.BadRequestException

class BadRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.apigateway.model.BasePathMapping

class 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

class ClientCertificate extends Object implements Serializable

Serialized Fields

clientCertificateId

String clientCertificateId

The identifier of the Client Certificate.

createdDate

Date createdDate

The date when the Client Certificate was created, in ISO 8601 format.

description

String description

The description of the Client Certificate.

expirationDate

Date expirationDate

The date when the Client Certificate will expire, in ISO 8601 format.

pemEncodedCertificate

String pemEncodedCertificate

The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .

Exception Class com.amazonaws.services.apigateway.model.ConflictException

class ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.apigateway.model.CreateApiKeyRequest

class CreateApiKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

The description of the ApiKey.

enabled

Boolean enabled

Specifies whether the ApiKey can be used by callers.

name

String name

The name of the ApiKey.

stageKeys

List<StageKey> stageKeys

Specifies whether the ApiKey can be used by callers.

Class com.amazonaws.services.apigateway.model.CreateApiKeyResult

class CreateApiKeyResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API Key was created, in ISO 8601 format.

description

String description

The description of the API Key.

enabled

Boolean enabled

Specifies whether the API Key can be used by callers.

id

String id

The identifier of the API Key.

lastUpdatedDate

Date lastUpdatedDate

When the API Key was last updated, in ISO 8601 format.

name

String name

The name of the API Key.

stageKeys

List<String> stageKeys

A list of Stage resources that are associated with the ApiKey resource.

Class com.amazonaws.services.apigateway.model.CreateAuthorizerRequest

class CreateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerCredentials

String authorizerCredentials

Specifies the credentials required for the authorizer, if any.

authorizerResultTtlInSeconds

Integer authorizerResultTtlInSeconds

The TTL of cached authorizer results.

authorizerUri

String authorizerUri

[Required] Specifies the authorizer's Uniform Resource Identifier (URI).

authType

String authType

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

identitySource

String identitySource

[Required] The source of the identity in an incoming request.

identityValidationExpression

String identityValidationExpression

A validation expression for the incoming identity.

name

String name

[Required] The name of the authorizer.

restApiId

String restApiId

The RestApi identifier under which the Authorizer will be created.

type

String type

[Required] The type of the authorizer.

Class com.amazonaws.services.apigateway.model.CreateAuthorizerResult

class CreateAuthorizerResult extends Object implements Serializable

Serialized Fields

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.

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.

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

authType

String authType

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

id

String id

The identifier for the authorizer resource.

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.

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.

Class com.amazonaws.services.apigateway.model.CreateBasePathMappingRequest

class CreateBasePathMappingRequest extends AmazonWebServiceRequest 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. 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.

domainName

String domainName

The domain name of the BasePathMapping resource to create.

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

class 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

class CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

description

String description

The description for the Deployment resource to create.

restApiId

String restApiId

The RestApi resource identifier for the Deployment resource to create.

stageDescription

String stageDescription

The description of the Stage resource for the Deployment resource to create.

stageName

String stageName

The name of the Stage resource for the Deployment resource to create.

variables

Map<String,String> 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

class CreateDeploymentResult extends Object implements Serializable

Serialized Fields

apiSummary

Map<String, Map<String, MethodSnapshot>> apiSummary

Gets a summary of the RestApi at the date and time that the deployment resource was created.

createdDate

Date createdDate

The date and time that the deployment resource was created.

description

String description

The description for the deployment resource.

id

String id

The identifier for the deployment resource.

Class com.amazonaws.services.apigateway.model.CreateDomainNameRequest

class CreateDomainNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateBody

String certificateBody

The body of the server certificate provided by your certificate authority.

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.

certificateName

String certificateName

The name of the certificate.

certificatePrivateKey

String certificatePrivateKey

Your certificate's private key.

domainName

String domainName

The name of the DomainName resource.

Class com.amazonaws.services.apigateway.model.CreateDomainNameResult

class CreateDomainNameResult extends Object implements Serializable

Serialized Fields

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.

domainName

String domainName

The name of the DomainName resource.

Class com.amazonaws.services.apigateway.model.CreateModelRequest

class CreateModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contentType

String contentType

The content-type for the model.

description

String description

The description of the model.

name

String name

The name of the model.

restApiId

String restApiId

The RestApi identifier under which the Model will be created.

schema

String schema

The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

Class com.amazonaws.services.apigateway.model.CreateModelResult

class CreateModelResult extends Object implements Serializable

Serialized Fields

contentType

String contentType

The content-type for the model.

description

String description

The description of the model.

id

String id

The identifier for the model resource.

name

String name

The name of the model.

schema

String schema

The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

Class com.amazonaws.services.apigateway.model.CreateResourceRequest

class CreateResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parentId

String parentId

The parent resource's identifier.

pathPart

String pathPart

The last path segment for this resource.

restApiId

String restApiId

The identifier of the RestApi for the resource.

Class com.amazonaws.services.apigateway.model.CreateResourceResult

class CreateResourceResult extends Object implements Serializable

Serialized Fields

id

String id

The resource's identifier.

parentId

String parentId

The parent resource's identifier.

path

String path

The full path for this resource.

pathPart

String pathPart

The last path segment for this resource.

resourceMethods

Map<String,Method> 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

class CreateRestApiRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cloneFrom

String cloneFrom

The Id of the RestApi that you want to clone from.

description

String description

The description of the RestApi.

name

String name

The name of the RestApi.

Class com.amazonaws.services.apigateway.model.CreateRestApiResult

class CreateRestApiResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API was created, in ISO 8601 format.

description

String description

The API's description.

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.

warnings

List<String> warnings

Class com.amazonaws.services.apigateway.model.CreateStageRequest

class CreateStageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheClusterEnabled

Boolean cacheClusterEnabled

Whether cache clustering is enabled for the stage.

cacheClusterSize

String cacheClusterSize

The stage's cache cluster size.

deploymentId

String deploymentId

The identifier of the Deployment resource for the Stage resource.

description

String description

The description of the Stage resource.

restApiId

String restApiId

The identifier of the RestApi resource for the Stage resource to create.

stageName

String stageName

The name for the Stage resource.

variables

Map<String,String> 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

class CreateStageResult extends Object implements Serializable

Serialized Fields

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.

clientCertificateId

String clientCertificateId

createdDate

Date createdDate

The date and time that the stage was created, in ISO 8601 format.

deploymentId

String deploymentId

The identifier of the Deployment that the stage points to.

description

String description

The stage's description.

lastUpdatedDate

Date lastUpdatedDate

The date and time that information about the stage was last updated, in ISO 8601 format.

methodSettings

Map<String, MethodSetting> 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.

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.

variables

Map<String,String> 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-._~:/?#&=,]+.

Class com.amazonaws.services.apigateway.model.DeleteApiKeyRequest

class 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.DeleteApiKeyResult

class DeleteApiKeyResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteAuthorizerRequest

class DeleteAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerId

String authorizerId

The identifier of the Authorizer resource.

restApiId

String restApiId

The RestApi identifier for the Authorizer resource.

Class com.amazonaws.services.apigateway.model.DeleteAuthorizerResult

class DeleteAuthorizerResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteBasePathMappingRequest

class DeleteBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

basePath

String basePath

The base path name of the BasePathMapping resource to delete.

domainName

String domainName

The domain name of the BasePathMapping resource to delete.

Class com.amazonaws.services.apigateway.model.DeleteBasePathMappingResult

class DeleteBasePathMappingResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteClientCertificateRequest

class 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.DeleteClientCertificateResult

class DeleteClientCertificateResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteDeploymentRequest

class DeleteDeploymentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The identifier of the Deployment resource to delete.

restApiId

String restApiId

The identifier of the RestApi resource for the Deployment resource to delete.

Class com.amazonaws.services.apigateway.model.DeleteDeploymentResult

class DeleteDeploymentResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteDomainNameRequest

class 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.DeleteDomainNameResult

class DeleteDomainNameResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteIntegrationRequest

class DeleteIntegrationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Specifies a delete integration request's HTTP method.

resourceId

String resourceId

Specifies a delete integration request's resource identifier.

restApiId

String restApiId

Specifies a delete integration request's API identifier.

Class com.amazonaws.services.apigateway.model.DeleteIntegrationResponseRequest

class DeleteIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Specifies a delete integration response request's HTTP method.

resourceId

String resourceId

Specifies a delete integration response request's resource identifier.

restApiId

String restApiId

Specifies a delete integration response request's API identifier.

statusCode

String statusCode

Specifies a delete integration response request's status code.

Class com.amazonaws.services.apigateway.model.DeleteIntegrationResponseResult

class DeleteIntegrationResponseResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteIntegrationResult

class DeleteIntegrationResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteMethodRequest

class DeleteMethodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

The HTTP verb that identifies the Method resource.

resourceId

String resourceId

The Resource identifier for the Method resource.

restApiId

String restApiId

The RestApi identifier for the Method resource.

Class com.amazonaws.services.apigateway.model.DeleteMethodResponseRequest

class DeleteMethodResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

The HTTP verb identifier for the parent Method resource.

resourceId

String resourceId

The Resource identifier for the MethodResponse resource.

restApiId

String restApiId

The RestApi identifier for the MethodResponse resource.

statusCode

String statusCode

The status code identifier for the MethodResponse resource.

Class com.amazonaws.services.apigateway.model.DeleteMethodResponseResult

class DeleteMethodResponseResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteMethodResult

class DeleteMethodResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteModelRequest

class DeleteModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

modelName

String modelName

The name of the model to delete.

restApiId

String restApiId

The RestApi under which the model will be deleted.

Class com.amazonaws.services.apigateway.model.DeleteModelResult

class DeleteModelResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteResourceRequest

class DeleteResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceId

String resourceId

The identifier of the Resource resource.

restApiId

String restApiId

The RestApi identifier for the Resource resource.

Class com.amazonaws.services.apigateway.model.DeleteResourceResult

class DeleteResourceResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteRestApiRequest

class 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.DeleteRestApiResult

class DeleteRestApiResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.DeleteStageRequest

class 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.DeleteStageResult

class DeleteStageResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.Deployment

class Deployment extends Object implements Serializable

Serialized Fields

apiSummary

Map<String, Map<String, MethodSnapshot>> apiSummary

Gets a summary of the RestApi at the date and time that the deployment resource was created.

createdDate

Date createdDate

The date and time that the deployment resource was created.

description

String description

The description for the deployment resource.

id

String id

The identifier for the deployment resource.

Class com.amazonaws.services.apigateway.model.DomainName

class DomainName extends Object implements Serializable

Serialized Fields

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.

domainName

String domainName

The name of the DomainName resource.

Class com.amazonaws.services.apigateway.model.FlushStageAuthorizersCacheRequest

class 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.FlushStageAuthorizersCacheResult

class FlushStageAuthorizersCacheResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.FlushStageCacheRequest

class 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.FlushStageCacheResult

class FlushStageCacheResult extends Object implements Serializable

Class com.amazonaws.services.apigateway.model.GenerateClientCertificateRequest

class GenerateClientCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

The description of the ClientCertificate.

Class com.amazonaws.services.apigateway.model.GenerateClientCertificateResult

class GenerateClientCertificateResult extends Object implements Serializable

Serialized Fields

clientCertificateId

String clientCertificateId

The identifier of the Client Certificate.

createdDate

Date createdDate

The date when the Client Certificate was created, in ISO 8601 format.

description

String description

The description of the Client Certificate.

expirationDate

Date expirationDate

The date when the Client Certificate will expire, in ISO 8601 format.

pemEncodedCertificate

String pemEncodedCertificate

The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .

Class com.amazonaws.services.apigateway.model.GetAccountRequest

class GetAccountRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.apigateway.model.GetAccountResult

class 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

class GetApiKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

apiKey

String apiKey

The identifier of the ApiKey resource.

Class com.amazonaws.services.apigateway.model.GetApiKeyResult

class GetApiKeyResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API Key was created, in ISO 8601 format.

description

String description

The description of the API Key.

enabled

Boolean enabled

Specifies whether the API Key can be used by callers.

id

String id

The identifier of the API Key.

lastUpdatedDate

Date lastUpdatedDate

When the API Key was last updated, in ISO 8601 format.

name

String name

The name of the API Key.

stageKeys

List<String> stageKeys

A list of Stage resources that are associated with the ApiKey resource.

Class com.amazonaws.services.apigateway.model.GetApiKeysRequest

class GetApiKeysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

Integer limit

The maximum number of ApiKeys to get information about.

position

String position

The position of the current ApiKeys resource to get information about.

Class com.amazonaws.services.apigateway.model.GetApiKeysResult

class GetApiKeysResult extends Object implements Serializable

Serialized Fields

items

List<ApiKey> items

The current page of any ApiKey resources in the collection of ApiKey resources.

position

String position

Class com.amazonaws.services.apigateway.model.GetAuthorizerRequest

class GetAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerId

String authorizerId

The identifier of the Authorizer resource.

restApiId

String restApiId

The RestApi identifier for the Authorizer resource.

Class com.amazonaws.services.apigateway.model.GetAuthorizerResult

class GetAuthorizerResult extends Object implements Serializable

Serialized Fields

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.

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.

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

authType

String authType

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

id

String id

The identifier for the authorizer resource.

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.

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.

Class com.amazonaws.services.apigateway.model.GetAuthorizersRequest

class GetAuthorizersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

Integer limit

Limit the number of Authorizer resources in the response.

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.

restApiId

String restApiId

The RestApi identifier for the Authorizers resource.

Class com.amazonaws.services.apigateway.model.GetAuthorizersResult

class GetAuthorizersResult extends Object implements Serializable

Serialized Fields

items

List<Authorizer> items

Gets the current list of Authorizer resources in the collection.

position

String position

Class com.amazonaws.services.apigateway.model.GetBasePathMappingRequest

class GetBasePathMappingRequest extends AmazonWebServiceRequest 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. 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.

domainName

String domainName

The domain name of the BasePathMapping resource to be described.

Class com.amazonaws.services.apigateway.model.GetBasePathMappingResult

class 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

class GetBasePathMappingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The domain name of a BasePathMapping resource.

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.

position

String position

The position of the current BasePathMapping resource in the collection to get information about.

Class com.amazonaws.services.apigateway.model.GetBasePathMappingsResult

class GetBasePathMappingsResult extends Object implements Serializable

Serialized Fields

items

List<BasePathMapping> items

The current page of any BasePathMapping resources in the collection of base path mapping resources.

position

String position

Class com.amazonaws.services.apigateway.model.GetClientCertificateRequest

class 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

class GetClientCertificateResult extends Object implements Serializable

Serialized Fields

clientCertificateId

String clientCertificateId

The identifier of the Client Certificate.

createdDate

Date createdDate

The date when the Client Certificate was created, in ISO 8601 format.

description

String description

The description of the Client Certificate.

expirationDate

Date expirationDate

The date when the Client Certificate will expire, in ISO 8601 format.

pemEncodedCertificate

String pemEncodedCertificate

The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .

Class com.amazonaws.services.apigateway.model.GetClientCertificatesRequest

class GetClientCertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

position

String position

The position of the current ClientCertificate resource in the collection to get information about.

Class com.amazonaws.services.apigateway.model.GetClientCertificatesResult

class GetClientCertificatesResult extends Object implements Serializable

Serialized Fields

items

List<ClientCertificate> items

The current page of any ClientCertificate resources in the collection of ClientCertificate resources.

position

String position

Class com.amazonaws.services.apigateway.model.GetDeploymentRequest

class GetDeploymentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The identifier of the Deployment resource to get information about.

restApiId

String restApiId

The identifier of the RestApi resource for the Deployment resource to get information about.

Class com.amazonaws.services.apigateway.model.GetDeploymentResult

class GetDeploymentResult extends Object implements Serializable

Serialized Fields

apiSummary

Map<String, Map<String, MethodSnapshot>> apiSummary

Gets a summary of the RestApi at the date and time that the deployment resource was created.

createdDate

Date createdDate

The date and time that the deployment resource was created.

description

String description

The description for the deployment resource.

id

String id

The identifier for the deployment resource.

Class com.amazonaws.services.apigateway.model.GetDeploymentsRequest

class GetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

position

String position

The position of the current Deployment resource in the collection to get information about.

restApiId

String restApiId

The identifier of the RestApi resource for the collection of Deployment resources to get information about.

Class com.amazonaws.services.apigateway.model.GetDeploymentsResult

class GetDeploymentsResult extends Object implements Serializable

Serialized Fields

items

List<Deployment> items

The current page of any Deployment resources in the collection of deployment resources.

position

String position

Class com.amazonaws.services.apigateway.model.GetDomainNameRequest

class GetDomainNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the DomainName resource.

Class com.amazonaws.services.apigateway.model.GetDomainNameResult

class GetDomainNameResult extends Object implements Serializable

Serialized Fields

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.

domainName

String domainName

The name of the DomainName resource.

Class com.amazonaws.services.apigateway.model.GetDomainNamesRequest

class GetDomainNamesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

position

String position

The position of the current domain names to get information about.

Class com.amazonaws.services.apigateway.model.GetDomainNamesResult

class GetDomainNamesResult extends Object implements Serializable

Serialized Fields

items

List<DomainName> items

The current page of any DomainName resources in the collection of DomainName resources.

position

String position

Class com.amazonaws.services.apigateway.model.GetExportRequest

class GetExportRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

exportType

String exportType

The type of export. Currently only 'swagger' is supported.

parameters

Map<String,String> 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

restApiId

String restApiId

The identifier of the RestApi to be exported.

stageName

String stageName

The name of the Stage that will be exported.

Class com.amazonaws.services.apigateway.model.GetExportResult

class GetExportResult extends Object implements Serializable

Serialized Fields

body

ByteBuffer body

The binary blob response to GetExport, which contains the export.

contentDisposition

String contentDisposition

The content-disposition header value in the HTTP reseponse.

contentType

String contentType

The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

Class com.amazonaws.services.apigateway.model.GetIntegrationRequest

class GetIntegrationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Specifies a get integration request's HTTP method.

resourceId

String resourceId

Specifies a get integration request's resource identifier

restApiId

String restApiId

Specifies a get integration request's API identifier.

Class com.amazonaws.services.apigateway.model.GetIntegrationResponseRequest

class GetIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Specifies a get integration response request's HTTP method.

resourceId

String resourceId

Specifies a get integration response request's resource identifier.

restApiId

String restApiId

Specifies a get integration response request's API identifier.

statusCode

String statusCode

Specifies a get integration response request's status code.

Class com.amazonaws.services.apigateway.model.GetIntegrationResponseResult

class GetIntegrationResponseResult extends Object implements Serializable

Serialized Fields

responseParameters

Map<String,String> 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<String,String> 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.

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.

statusCode

String statusCode

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Class com.amazonaws.services.apigateway.model.GetIntegrationResult

class GetIntegrationResult extends Object implements Serializable

Serialized Fields

cacheKeyParameters

List<String> cacheKeyParameters

Specifies the integration's cache key parameters.

cacheNamespace

String cacheNamespace

Specifies the integration's cache namespace.

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.

httpMethod

String httpMethod

Specifies the integration's HTTP method type.

integrationResponses

Map<String, IntegrationResponse> integrationResponses

Specifies the integration's responses.

passthroughBehavior

String passthroughBehavior

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the Integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

WHEN_NO_TEMPLATES will allow pass-through when the Integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

requestParameters

Map<String,String> 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<String,String> requestTemplates

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

type

String type

Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.

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

Class com.amazonaws.services.apigateway.model.GetMethodRequest

class GetMethodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Specifies the put method request's HTTP method type.

resourceId

String resourceId

The Resource identifier for the Method resource.

restApiId

String restApiId

The RestApi identifier for the Method resource.

Class com.amazonaws.services.apigateway.model.GetMethodResponseRequest

class GetMethodResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

The HTTP verb identifier for the parent Method resource.

resourceId

String resourceId

The Resource identifier for the MethodResponse resource.

restApiId

String restApiId

The RestApi identifier for the MethodResponse resource.

statusCode

String statusCode

The status code identifier for the MethodResponse resource.

Class com.amazonaws.services.apigateway.model.GetMethodResponseResult

class GetMethodResponseResult extends Object implements Serializable

Serialized Fields

responseModels

Map<String,String> 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.

responseParameters

Map<String,Boolean> 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.

statusCode

String statusCode

The method response's status code.

Class com.amazonaws.services.apigateway.model.GetMethodResult

class GetMethodResult extends Object implements Serializable

Serialized Fields

apiKeyRequired

Boolean apiKeyRequired

Specifies whether the method requires a valid ApiKey.

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.

httpMethod

String httpMethod

The HTTP method.

methodIntegration

Integration methodIntegration

The method's integration.

methodResponses

Map<String, MethodResponse> 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.

requestModels

Map<String,String> 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.

requestParameters

Map<String,Boolean> 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.

Class com.amazonaws.services.apigateway.model.GetModelRequest

class GetModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

flatten

Boolean flatten

Resolves all external model references and returns a flattened model schema.

modelName

String modelName

The name of the model as an identifier.

restApiId

String restApiId

The RestApi identifier under which the Model exists.

Class com.amazonaws.services.apigateway.model.GetModelResult

class GetModelResult extends Object implements Serializable

Serialized Fields

contentType

String contentType

The content-type for the model.

description

String description

The description of the model.

id

String id

The identifier for the model resource.

name

String name

The name of the model.

schema

String schema

The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

Class com.amazonaws.services.apigateway.model.GetModelsRequest

class GetModelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

position

String position

The position of the next set of results in the Models resource to get information about.

restApiId

String restApiId

The RestApi identifier.

Class com.amazonaws.services.apigateway.model.GetModelsResult

class GetModelsResult extends Object implements Serializable

Serialized Fields

items

List<Model> items

Gets the current Model resource in the collection.

position

String position

Class com.amazonaws.services.apigateway.model.GetModelTemplateRequest

class GetModelTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

modelName

String modelName

The name of the model for which to generate a template.

restApiId

String restApiId

The ID of the RestApi under which the model exists.

Class com.amazonaws.services.apigateway.model.GetModelTemplateResult

class 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

class GetResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceId

String resourceId

The identifier for the Resource resource.

restApiId

String restApiId

The RestApi identifier for the resource.

Class com.amazonaws.services.apigateway.model.GetResourceResult

class GetResourceResult extends Object implements Serializable

Serialized Fields

id

String id

The resource's identifier.

parentId

String parentId

The parent resource's identifier.

path

String path

The full path for this resource.

pathPart

String pathPart

The last path segment for this resource.

resourceMethods

Map<String,Method> 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

class GetResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

position

String position

The position of the next set of results in the current Resources resource to get information about.

restApiId

String restApiId

The RestApi identifier for the Resource.

Class com.amazonaws.services.apigateway.model.GetResourcesResult

class GetResourcesResult extends Object implements Serializable

Serialized Fields

items

List<Resource> items

Gets the current Resource resource in the collection.

position

String position

Class com.amazonaws.services.apigateway.model.GetRestApiRequest

class GetRestApiRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

restApiId

String restApiId

The identifier of the RestApi resource.

Class com.amazonaws.services.apigateway.model.GetRestApiResult

class GetRestApiResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API was created, in ISO 8601 format.

description

String description

The API's description.

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.

warnings

List<String> warnings

Class com.amazonaws.services.apigateway.model.GetRestApisRequest

class GetRestApisRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

position

String position

The position of the current RestApis resource in the collection to get information about.

Class com.amazonaws.services.apigateway.model.GetRestApisResult

class GetRestApisResult extends Object implements Serializable

Serialized Fields

items

List<RestApi> items

An array of links to the current page of RestApi resources.

position

String position

Class com.amazonaws.services.apigateway.model.GetSdkRequest

class GetSdkRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameters

Map<String,String> 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.

restApiId

String restApiId

The identifier of the RestApi that the SDK will use.

sdkType

String sdkType

The language for the generated SDK. Currently javascript, android, and objectivec (for iOS) are supported.

stageName

String stageName

The name of the Stage that the SDK will use.

Class com.amazonaws.services.apigateway.model.GetSdkResult

class GetSdkResult extends Object implements Serializable

Serialized Fields

body

ByteBuffer body

The binary blob response to GetSdk, which contains the generated SDK.

contentDisposition

String contentDisposition

The content-disposition header value in the HTTP reseponse.

contentType

String contentType

The content-type header value in the HTTP response.

Class com.amazonaws.services.apigateway.model.GetStageRequest

class 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

class GetStageResult extends Object implements Serializable

Serialized Fields

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.

clientCertificateId

String clientCertificateId

createdDate

Date createdDate

The date and time that the stage was created, in ISO 8601 format.

deploymentId

String deploymentId

The identifier of the Deployment that the stage points to.

description

String description

The stage's description.

lastUpdatedDate

Date lastUpdatedDate

The date and time that information about the stage was last updated, in ISO 8601 format.

methodSettings

Map<String, MethodSetting> 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.

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.

variables

Map<String,String> 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-._~:/?#&=,]+.

Class com.amazonaws.services.apigateway.model.GetStagesRequest

class GetStagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The stages' deployment identifiers.

restApiId

String restApiId

The stages' API identifiers.

Class com.amazonaws.services.apigateway.model.GetStagesResult

class GetStagesResult extends Object implements Serializable

Serialized Fields

item

List<Stage> item

An individual Stage resource.

Class com.amazonaws.services.apigateway.model.ImportRestApiRequest

class ImportRestApiRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

body

ByteBuffer body

The POST request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

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<String,String> parameters

Custom header parameters as part of the request.

Class com.amazonaws.services.apigateway.model.ImportRestApiResult

class ImportRestApiResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API was created, in ISO 8601 format.

description

String description

The API's description.

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.

warnings

List<String> warnings

Class com.amazonaws.services.apigateway.model.Integration

class Integration extends Object implements Serializable

Serialized Fields

cacheKeyParameters

List<String> cacheKeyParameters

Specifies the integration's cache key parameters.

cacheNamespace

String cacheNamespace

Specifies the integration's cache namespace.

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.

httpMethod

String httpMethod

Specifies the integration's HTTP method type.

integrationResponses

Map<String, IntegrationResponse> integrationResponses

Specifies the integration's responses.

passthroughBehavior

String passthroughBehavior

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the Integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

WHEN_NO_TEMPLATES will allow pass-through when the Integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

requestParameters

Map<String,String> 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<String,String> requestTemplates

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

type

String type

Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.

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

Class com.amazonaws.services.apigateway.model.IntegrationResponse

class IntegrationResponse extends Object implements Serializable

Serialized Fields

responseParameters

Map<String,String> 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<String,String> 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.

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.

statusCode

String statusCode

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Exception Class com.amazonaws.services.apigateway.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

retryAfterSeconds

String retryAfterSeconds

Class com.amazonaws.services.apigateway.model.Method

class Method extends Object implements Serializable

Serialized Fields

apiKeyRequired

Boolean apiKeyRequired

Specifies whether the method requires a valid ApiKey.

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.

httpMethod

String httpMethod

The HTTP method.

methodIntegration

Integration methodIntegration

The method's integration.

methodResponses

Map<String, MethodResponse> 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.

requestModels

Map<String,String> 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.

requestParameters

Map<String,Boolean> 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.

Class com.amazonaws.services.apigateway.model.MethodResponse

class MethodResponse extends Object implements Serializable

Serialized Fields

responseModels

Map<String,String> 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.

responseParameters

Map<String,Boolean> 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.

statusCode

String statusCode

The method response's status code.

Class com.amazonaws.services.apigateway.model.MethodSetting

class MethodSetting extends Object implements Serializable

Serialized Fields

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.

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.

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.

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.

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.

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.

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.

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.

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

class MethodSnapshot extends Object implements Serializable

Serialized Fields

apiKeyRequired

Boolean apiKeyRequired

Specifies whether the method requires a valid ApiKey.

authorizationType

String authorizationType

Specifies the type of authorization used for the method.

Class com.amazonaws.services.apigateway.model.Model

class Model extends Object implements Serializable

Serialized Fields

contentType

String contentType

The content-type for the model.

description

String description

The description of the model.

id

String id

The identifier for the model resource.

name

String name

The name of the model.

schema

String schema

The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

Exception Class com.amazonaws.services.apigateway.model.NotFoundException

class NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.apigateway.model.PatchOperation

class PatchOperation extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.apigateway.model.PutIntegrationRequest

class PutIntegrationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheKeyParameters

List<String> cacheKeyParameters

Specifies a put integration input's cache key parameters.

cacheNamespace

String cacheNamespace

Specifies a put integration input's cache namespace.

credentials

String credentials

Specifies whether credentials are required for a put integration.

httpMethod

String httpMethod

Specifies a put integration request's HTTP method.

integrationHttpMethod

String integrationHttpMethod

Specifies a put integration HTTP method. When the integration type is HTTP or AWS, this field is required.

passthroughBehavior

String passthroughBehavior

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the Integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

WHEN_NO_TEMPLATES will allow pass-through when the Integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

requestParameters

Map<String,String> 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<String,String> requestTemplates

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

resourceId

String resourceId

Specifies a put integration request's resource ID.

restApiId

String restApiId

Specifies a put integration request's API identifier.

type

String type

Specifies a put integration input's type.

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.

Class com.amazonaws.services.apigateway.model.PutIntegrationResponseRequest

class PutIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Specifies a put integration response request's HTTP method.

resourceId

String resourceId

Specifies a put integration response request's resource identifier.

responseParameters

Map<String,String> 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<String,String> responseTemplates

Specifies a put integration response's templates.

restApiId

String restApiId

Specifies a put integration response request's API identifier.

selectionPattern

String selectionPattern

Specifies the selection pattern of a put integration response.

statusCode

String statusCode

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Class com.amazonaws.services.apigateway.model.PutIntegrationResponseResult

class PutIntegrationResponseResult extends Object implements Serializable

Serialized Fields

responseParameters

Map<String,String> 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<String,String> 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.

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.

statusCode

String statusCode

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Class com.amazonaws.services.apigateway.model.PutIntegrationResult

class PutIntegrationResult extends Object implements Serializable

Serialized Fields

cacheKeyParameters

List<String> cacheKeyParameters

Specifies the integration's cache key parameters.

cacheNamespace

String cacheNamespace

Specifies the integration's cache namespace.

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.

httpMethod

String httpMethod

Specifies the integration's HTTP method type.

integrationResponses

Map<String, IntegrationResponse> integrationResponses

Specifies the integration's responses.

passthroughBehavior

String passthroughBehavior

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the Integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

WHEN_NO_TEMPLATES will allow pass-through when the Integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

requestParameters

Map<String,String> 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<String,String> requestTemplates

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

type

String type

Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.

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

Class com.amazonaws.services.apigateway.model.PutMethodRequest

class PutMethodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

apiKeyRequired

Boolean apiKeyRequired

Specifies whether the method required a valid ApiKey.

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.

httpMethod

String httpMethod

Specifies the put method request's HTTP method type.

requestModels

Map<String,String> 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.

requestParameters

Map<String,Boolean> 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.

resourceId

String resourceId

The Resource identifier for the new Method resource.

restApiId

String restApiId

The RestApi identifier for the new Method resource.

Class com.amazonaws.services.apigateway.model.PutMethodResponseRequest

class PutMethodResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

The HTTP verb that identifies the Method resource.

resourceId

String resourceId

The Resource identifier for the Method resource.

responseModels

Map<String,String> 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.

responseParameters

Map<String,Boolean> 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.

restApiId

String restApiId

The RestApi identifier for the Method resource.

statusCode

String statusCode

The method response's status code.

Class com.amazonaws.services.apigateway.model.PutMethodResponseResult

class PutMethodResponseResult extends Object implements Serializable

Serialized Fields

responseModels

Map<String,String> 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.

responseParameters

Map<String,Boolean> 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.

statusCode

String statusCode

The method response's status code.

Class com.amazonaws.services.apigateway.model.PutMethodResult

class PutMethodResult extends Object implements Serializable

Serialized Fields

apiKeyRequired

Boolean apiKeyRequired

Specifies whether the method requires a valid ApiKey.

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.

httpMethod

String httpMethod

The HTTP method.

methodIntegration

Integration methodIntegration

The method's integration.

methodResponses

Map<String, MethodResponse> 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.

requestModels

Map<String,String> 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.

requestParameters

Map<String,Boolean> 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.

Class com.amazonaws.services.apigateway.model.PutRestApiRequest

class PutRestApiRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

body

ByteBuffer body

The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

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.

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

parameters

Map<String,String> parameters

Custom headers supplied as part of the request.

restApiId

String restApiId

The identifier of the RestApi to be updated.

Class com.amazonaws.services.apigateway.model.PutRestApiResult

class PutRestApiResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API was created, in ISO 8601 format.

description

String description

The API's description.

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.

warnings

List<String> warnings

Class com.amazonaws.services.apigateway.model.Resource

class Resource extends Object implements Serializable

Serialized Fields

id

String id

The resource's identifier.

parentId

String parentId

The parent resource's identifier.

path

String path

The full path for this resource.

pathPart

String pathPart

The last path segment for this resource.

resourceMethods

Map<String,Method> 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

class RestApi extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API was created, in ISO 8601 format.

description

String description

The API's description.

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.

warnings

List<String> warnings

Exception Class com.amazonaws.services.apigateway.model.ServiceUnavailableException

class ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

retryAfterSeconds

String retryAfterSeconds

Class com.amazonaws.services.apigateway.model.Stage

class Stage extends Object implements Serializable

Serialized Fields

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.

clientCertificateId

String clientCertificateId

createdDate

Date createdDate

The date and time that the stage was created, in ISO 8601 format.

deploymentId

String deploymentId

The identifier of the Deployment that the stage points to.

description

String description

The stage's description.

lastUpdatedDate

Date lastUpdatedDate

The date and time that information about the stage was last updated, in ISO 8601 format.

methodSettings

Map<String, MethodSetting> 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.

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.

variables

Map<String,String> 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-._~:/?#&=,]+.

Class com.amazonaws.services.apigateway.model.StageKey

class 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

class TestInvokeAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalContext

Map<String,String> additionalContext

[Optional] A key-value map of additional context variables.

authorizerId

String authorizerId

Specifies a test invoke authorizer request's Authorizer ID.

body

String body

[Optional] The simulated request body of an incoming invocation request.

headers

Map<String,String> 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.

restApiId

String restApiId

Specifies a test invoke authorizer request's RestApi identifier.

stageVariables

Map<String,String> stageVariables

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Class com.amazonaws.services.apigateway.model.TestInvokeAuthorizerResult

class TestInvokeAuthorizerResult extends Object implements Serializable

Serialized Fields

authorization

Map<String, List<String>> authorization

clientStatus

Integer clientStatus

The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

latency

Long latency

The execution latency of the test authorizer request

log

String log

The Amazon API Gateway execution log for the test authorizer request.

policy

String policy

The policy JSON document returned by the Authorizer

principalId

String principalId

The principal identity returned by the Authorizer

Class com.amazonaws.services.apigateway.model.TestInvokeMethodRequest

class TestInvokeMethodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

body

String body

The simulated request body of 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.

headers

Map<String,String> headers

A key-value map of headers to simulate an incoming invocation request.

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.

resourceId

String resourceId

Specifies a test invoke method request's resource ID.

restApiId

String restApiId

Specifies a test invoke method request's API identifier.

stageVariables

Map<String,String> stageVariables

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Class com.amazonaws.services.apigateway.model.TestInvokeMethodResult

class TestInvokeMethodResult extends Object implements Serializable

Serialized Fields

body

String body

The body of HTTP response.

headers

Map<String,String> headers

The headers of HTTP response.

latency

Long latency

The execution latency of the test invoke request.

log

String log

The Amazon API Gateway execution log for the test invoke request.

status

Integer status

The HTTP status code.

Class com.amazonaws.services.apigateway.model.ThrottleSettings

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

Exception Class com.amazonaws.services.apigateway.model.TooManyRequestsException

class TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

retryAfterSeconds

String retryAfterSeconds

Exception Class com.amazonaws.services.apigateway.model.UnauthorizedException

class UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.apigateway.model.UpdateAccountRequest

class UpdateAccountRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

patchOperations

List<PatchOperation> 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

class 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

class UpdateApiKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

apiKey

String apiKey

The identifier of the ApiKey resource to be updated.

patchOperations

List<PatchOperation> 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

class UpdateApiKeyResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API Key was created, in ISO 8601 format.

description

String description

The description of the API Key.

enabled

Boolean enabled

Specifies whether the API Key can be used by callers.

id

String id

The identifier of the API Key.

lastUpdatedDate

Date lastUpdatedDate

When the API Key was last updated, in ISO 8601 format.

name

String name

The name of the API Key.

stageKeys

List<String> stageKeys

A list of Stage resources that are associated with the ApiKey resource.

Class com.amazonaws.services.apigateway.model.UpdateAuthorizerRequest

class UpdateAuthorizerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authorizerId

String authorizerId

The identifier of the Authorizer resource.

patchOperations

List<PatchOperation> 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.

restApiId

String restApiId

The RestApi identifier for the Authorizer resource.

Class com.amazonaws.services.apigateway.model.UpdateAuthorizerResult

class UpdateAuthorizerResult extends Object implements Serializable

Serialized Fields

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.

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.

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

authType

String authType

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

id

String id

The identifier for the authorizer resource.

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.

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.

Class com.amazonaws.services.apigateway.model.UpdateBasePathMappingRequest

class UpdateBasePathMappingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

basePath

String basePath

The base path of the BasePathMapping resource to change.

domainName

String domainName

The domain name of the BasePathMapping resource to change.

patchOperations

List<PatchOperation> 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

class 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

class UpdateClientCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientCertificateId

String clientCertificateId

The identifier of the ClientCertificate resource to be updated.

patchOperations

List<PatchOperation> 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

class UpdateClientCertificateResult extends Object implements Serializable

Serialized Fields

clientCertificateId

String clientCertificateId

The identifier of the Client Certificate.

createdDate

Date createdDate

The date when the Client Certificate was created, in ISO 8601 format.

description

String description

The description of the Client Certificate.

expirationDate

Date expirationDate

The date when the Client Certificate will expire, in ISO 8601 format.

pemEncodedCertificate

String pemEncodedCertificate

The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .

Class com.amazonaws.services.apigateway.model.UpdateDeploymentRequest

class UpdateDeploymentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The replacment identifier for the Deployment resource to change information about.

patchOperations

List<PatchOperation> 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.

restApiId

String restApiId

The replacement identifier of the RestApi resource for the Deployment resource to change information about.

Class com.amazonaws.services.apigateway.model.UpdateDeploymentResult

class UpdateDeploymentResult extends Object implements Serializable

Serialized Fields

apiSummary

Map<String, Map<String, MethodSnapshot>> apiSummary

Gets a summary of the RestApi at the date and time that the deployment resource was created.

createdDate

Date createdDate

The date and time that the deployment resource was created.

description

String description

The description for the deployment resource.

id

String id

The identifier for the deployment resource.

Class com.amazonaws.services.apigateway.model.UpdateDomainNameRequest

class UpdateDomainNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the DomainName resource to be changed.

patchOperations

List<PatchOperation> 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

class UpdateDomainNameResult extends Object implements Serializable

Serialized Fields

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.

domainName

String domainName

The name of the DomainName resource.

Class com.amazonaws.services.apigateway.model.UpdateIntegrationRequest

class UpdateIntegrationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Represents an update integration request's HTTP method.

patchOperations

List<PatchOperation> 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.

resourceId

String resourceId

Represents an update integration request's resource identifier.

restApiId

String restApiId

Represents an update integration request's API identifier.

Class com.amazonaws.services.apigateway.model.UpdateIntegrationResponseRequest

class UpdateIntegrationResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

Specifies an update integration response request's HTTP method.

patchOperations

List<PatchOperation> 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.

resourceId

String resourceId

Specifies an update integration response request's resource identifier.

restApiId

String restApiId

Specifies an update integration response request's API identifier.

statusCode

String statusCode

Specifies an update integration response request's status code.

Class com.amazonaws.services.apigateway.model.UpdateIntegrationResponseResult

class UpdateIntegrationResponseResult extends Object implements Serializable

Serialized Fields

responseParameters

Map<String,String> 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<String,String> 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.

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.

statusCode

String statusCode

Specifies the status code that is used to map the integration response to an existing MethodResponse.

Class com.amazonaws.services.apigateway.model.UpdateIntegrationResult

class UpdateIntegrationResult extends Object implements Serializable

Serialized Fields

cacheKeyParameters

List<String> cacheKeyParameters

Specifies the integration's cache key parameters.

cacheNamespace

String cacheNamespace

Specifies the integration's cache namespace.

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.

httpMethod

String httpMethod

Specifies the integration's HTTP method type.

integrationResponses

Map<String, IntegrationResponse> integrationResponses

Specifies the integration's responses.

passthroughBehavior

String passthroughBehavior

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available requestTemplates defined on the Integration. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

WHEN_NO_MATCH passes the request body for unmapped content types through to the Integration backend without transformation.

NEVER rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response.

WHEN_NO_TEMPLATES will allow pass-through when the Integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.

requestParameters

Map<String,String> 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<String,String> requestTemplates

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

type

String type

Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.

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

Class com.amazonaws.services.apigateway.model.UpdateMethodRequest

class UpdateMethodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

The HTTP verb that identifies the Method resource.

patchOperations

List<PatchOperation> 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.

resourceId

String resourceId

The Resource identifier for the Method resource.

restApiId

String restApiId

The RestApi identifier for the Method resource.

Class com.amazonaws.services.apigateway.model.UpdateMethodResponseRequest

class UpdateMethodResponseRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

httpMethod

String httpMethod

The HTTP verb identifier for the parent Method resource.

patchOperations

List<PatchOperation> 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.

resourceId

String resourceId

The Resource identifier for the MethodResponse resource.

restApiId

String restApiId

The RestApi identifier for the MethodResponse resource.

statusCode

String statusCode

The status code identifier for the MethodResponse resource.

Class com.amazonaws.services.apigateway.model.UpdateMethodResponseResult

class UpdateMethodResponseResult extends Object implements Serializable

Serialized Fields

responseModels

Map<String,String> 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.

responseParameters

Map<String,Boolean> 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.

statusCode

String statusCode

The method response's status code.

Class com.amazonaws.services.apigateway.model.UpdateMethodResult

class UpdateMethodResult extends Object implements Serializable

Serialized Fields

apiKeyRequired

Boolean apiKeyRequired

Specifies whether the method requires a valid ApiKey.

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.

httpMethod

String httpMethod

The HTTP method.

methodIntegration

Integration methodIntegration

The method's integration.

methodResponses

Map<String, MethodResponse> 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.

requestModels

Map<String,String> 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.

requestParameters

Map<String,Boolean> 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.

Class com.amazonaws.services.apigateway.model.UpdateModelRequest

class UpdateModelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

modelName

String modelName

The name of the model to update.

patchOperations

List<PatchOperation> 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.

restApiId

String restApiId

The RestApi identifier under which the model exists.

Class com.amazonaws.services.apigateway.model.UpdateModelResult

class UpdateModelResult extends Object implements Serializable

Serialized Fields

contentType

String contentType

The content-type for the model.

description

String description

The description of the model.

id

String id

The identifier for the model resource.

name

String name

The name of the model.

schema

String schema

The schema for the model. For application/json models, this should be JSON-schema draft v4 model.

Class com.amazonaws.services.apigateway.model.UpdateResourceRequest

class UpdateResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

patchOperations

List<PatchOperation> 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.

resourceId

String resourceId

The identifier of the Resource resource.

restApiId

String restApiId

The RestApi identifier for the Resource resource.

Class com.amazonaws.services.apigateway.model.UpdateResourceResult

class UpdateResourceResult extends Object implements Serializable

Serialized Fields

id

String id

The resource's identifier.

parentId

String parentId

The parent resource's identifier.

path

String path

The full path for this resource.

pathPart

String pathPart

The last path segment for this resource.

resourceMethods

Map<String,Method> 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

class UpdateRestApiRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

patchOperations

List<PatchOperation> 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.

restApiId

String restApiId

The ID of the RestApi you want to update.

Class com.amazonaws.services.apigateway.model.UpdateRestApiResult

class UpdateRestApiResult extends Object implements Serializable

Serialized Fields

createdDate

Date createdDate

The date when the API was created, in ISO 8601 format.

description

String description

The API's description.

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.

warnings

List<String> warnings

Class com.amazonaws.services.apigateway.model.UpdateStageRequest

class UpdateStageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

patchOperations

List<PatchOperation> 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.

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.

Class com.amazonaws.services.apigateway.model.UpdateStageResult

class UpdateStageResult extends Object implements Serializable

Serialized Fields

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.

clientCertificateId

String clientCertificateId

createdDate

Date createdDate

The date and time that the stage was created, in ISO 8601 format.

deploymentId

String deploymentId

The identifier of the Deployment that the stage points to.

description

String description

The stage's description.

lastUpdatedDate

Date lastUpdatedDate

The date and time that information about the stage was last updated, in ISO 8601 format.

methodSettings

Map<String, MethodSetting> 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.

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.

variables

Map<String,String> 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-._~:/?#&=,]+.

Package com.amazonaws.services.applicationautoscaling.model

Class com.amazonaws.services.applicationautoscaling.model.Alarm

class Alarm extends Object implements Serializable

Serialized Fields

alarmARN

String alarmARN

The Amazon Resource Name (ARN) of the alarm.

alarmName

String alarmName

The name of the alarm.

Exception Class com.amazonaws.services.applicationautoscaling.model.ConcurrentUpdateException

class ConcurrentUpdateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.DeleteScalingPolicyRequest

class DeleteScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the scaling policy to delete.

resourceId

String resourceId

The unique identifier string for the resource associated with the scaling policy. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp.

scalableDimension

String scalableDimension

The scalable dimension associated with the scaling policy. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.DeleteScalingPolicyResult

class DeleteScalingPolicyResult extends Object implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.DeregisterScalableTargetRequest

class DeregisterScalableTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceId

String resourceId

The unique identifier string for the resource associated with the scalable target. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp.

scalableDimension

String scalableDimension

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.DeregisterScalableTargetResult

class DeregisterScalableTargetResult extends Object implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalableTargetsRequest

class DescribeScalableTargetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

The maximum number of scalable target results returned by DescribeScalableTargets in paginated output. When this parameter is used, DescribeScalableTargets returns up to 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 DescribeScalableTargets request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalableTargets returns up to 50 results and a NextToken value, if applicable.

nextToken

String nextToken

The NextToken value returned from a previous paginated DescribeScalableTargets request. 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.

resourceIds

List<String> resourceIds

The unique identifier string for the resource associated with the scalable target. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp. If you specify a scalable dimension, you must also specify a resource ID.

scalableDimension

String scalableDimension

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service. If you specify a scalable dimension, you must also specify a resource ID.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalableTargetsResult

class DescribeScalableTargetsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The NextToken value to include in a future DescribeScalableTargets request. When the results of a DescribeScalableTargets 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.

scalableTargets

List<ScalableTarget> scalableTargets

The list of scalable targets that matches the request parameters.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingActivitiesRequest

class DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

The maximum number of scaling activity results returned by DescribeScalingActivities in paginated output. When this parameter is used, DescribeScalingActivities returns up to 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 DescribeScalingActivities request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingActivities returns up to 50 results and a NextToken value, if applicable.

nextToken

String nextToken

The NextToken value returned from a previous paginated DescribeScalingActivities request. 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.

resourceId

String resourceId

The unique identifier string for the resource associated with the scaling activity. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp. If you specify a scalable dimension, you must also specify a resource ID.

scalableDimension

String scalableDimension

The scalable dimension associated with the scaling activity. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service. If you specify a scalable dimension, you must also specify a resource ID.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scaling activity is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingActivitiesResult

class DescribeScalingActivitiesResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The NextToken value to include in a future DescribeScalingActivities request. When the results of a DescribeScalingActivities 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.

scalingActivities

List<ScalingActivity> scalingActivities

A list of scaling activity objects.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingPoliciesRequest

class DescribeScalingPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

The maximum number of scaling policy results returned by DescribeScalingPolicies in paginated output. When this parameter is used, DescribeScalingPolicies returns up to 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 DescribeScalingPolicies request with the returned NextToken value. This value can be between 1 and 50. If this parameter is not used, then DescribeScalingPolicies returns up to 50 results and a NextToken value, if applicable.

nextToken

String nextToken

The NextToken value returned from a previous paginated DescribeScalingPolicies request. 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.

policyNames

List<String> policyNames

The names of the scaling policies to describe.

resourceId

String resourceId

The unique resource identifier string of the scalable target that the scaling policy is associated with. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp. If you specify a scalable dimension, you must also specify a resource ID.

scalableDimension

String scalableDimension

The scalable dimension of the scalable target that the scaling policy is associated with. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service. If you specify a scalable dimension, you must also specify a resource ID.

serviceNamespace

String serviceNamespace

The AWS service namespace of the scalable target that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingPoliciesResult

class DescribeScalingPoliciesResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The NextToken value to include in a future DescribeScalingPolicies request. When the results of a DescribeScalingPolicies 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.

scalingPolicies

List<ScalingPolicy> scalingPolicies

A list of scaling policy objects.

Exception Class com.amazonaws.services.applicationautoscaling.model.FailedResourceAccessException

class FailedResourceAccessException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.applicationautoscaling.model.InternalServiceException

class InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.applicationautoscaling.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.applicationautoscaling.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.applicationautoscaling.model.ObjectNotFoundException

class ObjectNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyRequest

class PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the scaling policy.

policyType

String policyType

The policy type. This parameter is required if you are creating a new policy.

resourceId

String resourceId

The unique resource identifier string for the scalable target that this scaling policy applies to. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp.

scalableDimension

String scalableDimension

The scalable dimension of the scalable target that this scaling policy applies to. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service.

serviceNamespace

String serviceNamespace

The AWS service namespace of the scalable target that this scaling policy applies to. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

stepScalingPolicyConfiguration

StepScalingPolicyConfiguration stepScalingPolicyConfiguration

The configuration for the step scaling policy. This parameter is required if you are creating a new policy. For more information, see StepScalingPolicyConfiguration and StepAdjustment in the Application Auto Scaling API Reference.

Class com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyResult

class PutScalingPolicyResult extends Object implements Serializable

Serialized Fields

policyARN

String policyARN

The Amazon Resource Name (ARN) of the resulting scaling policy.

Class com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetRequest

class RegisterScalableTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxCapacity

Integer maxCapacity

The maximum value for this scalable target to scale out to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

minCapacity

Integer minCapacity

The minimum value for this scalable target to scale in to in response to scaling activities. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

resourceId

String resourceId

The unique identifier string for the resource to associate with the scalable target. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp.

roleARN

String roleARN

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf. This parameter is required if you are registering a new scalable target, and it is optional if you are updating an existing one.

scalableDimension

String scalableDimension

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scalable target is associated with. For Amazon ECS services, the namespace value is ecs. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetResult

class RegisterScalableTargetResult extends Object implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.ScalableTarget

class ScalableTarget extends Object implements Serializable

Serialized Fields

creationTime

Date creationTime

The Unix timestamp for when the scalable target was created.

maxCapacity

Integer maxCapacity

The maximum value for this scalable target to scale out to in response to scaling activities.

minCapacity

Integer minCapacity

The minimum value for this scalable target to scale in to in response to scaling activities.

resourceId

String resourceId

The unique identifier string for the resource associated with the scalable target. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp.

roleARN

String roleARN

The ARN of the IAM role that allows Application Auto Scaling to modify your scalable target on your behalf.

scalableDimension

String scalableDimension

The scalable dimension associated with the scalable target. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scalable target is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.ScalingActivity

class ScalingActivity extends Object implements Serializable

Serialized Fields

activityId

String activityId

The unique identifier string for the scaling activity.

cause

String cause

A simple description of what caused the scaling activity to happen.

description

String description

A simple description of what action the scaling activity intends to accomplish.

details

String details

The details about the scaling activity.

endTime

Date endTime

The Unix timestamp for when the scaling activity ended.

resourceId

String resourceId

The unique identifier string for the resource associated with the scaling activity. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp.

scalableDimension

String scalableDimension

The scalable dimension associated with the scaling activity. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scaling activity is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

startTime

Date startTime

The Unix timestamp for when the scaling activity began.

statusCode

String statusCode

Indicates the status of the scaling activity.

statusMessage

String statusMessage

A simple message about the current status of the scaling activity.

Class com.amazonaws.services.applicationautoscaling.model.ScalingPolicy

class ScalingPolicy extends Object implements Serializable

Serialized Fields

alarms

List<Alarm> alarms

The CloudWatch alarms that are associated with the scaling policy.

creationTime

Date creationTime

The Unix timestamp for when the scaling policy was created.

policyARN

String policyARN

The Amazon Resource Name (ARN) of the scaling policy.

policyName

String policyName

The name of the scaling policy.

policyType

String policyType

The scaling policy type.

resourceId

String resourceId

The unique identifier string for the resource associated with the scaling policy. For Amazon ECS services, this value is the resource type, followed by the cluster name and service name, such as service/default/sample-webapp.

scalableDimension

String scalableDimension

The scalable dimension associated with the scaling policy. The scalable dimension contains the service namespace, resource type, and scaling property, such as ecs:service:DesiredCount for the desired task count of an Amazon ECS service.

serviceNamespace

String serviceNamespace

The namespace for the AWS service that the scaling policy is associated with. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

stepScalingPolicyConfiguration

StepScalingPolicyConfiguration stepScalingPolicyConfiguration

The configuration for the step scaling policy.

Class com.amazonaws.services.applicationautoscaling.model.StepAdjustment

class 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 scalable dimension while a negative number removes from the current scalable dimension.

Class com.amazonaws.services.applicationautoscaling.model.StepScalingPolicyConfiguration

class StepScalingPolicyConfiguration extends Object implements Serializable

Serialized Fields

adjustmentType

String adjustmentType

The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

cooldown

Integer cooldown

The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

For scale out policies, while Cooldown is in effect, the capacity that has been added by the previous scale out event that initiated the Cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a Cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

For scale in policies, the Cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the Cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

metricAggregationType

String metricAggregationType

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

minAdjustmentMagnitude

Integer minAdjustmentMagnitude

The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

stepAdjustments

List<StepAdjustment> stepAdjustments

A set of adjustments that enable you to scale based on the size of the alarm breach.

Exception Class com.amazonaws.services.applicationautoscaling.model.ValidationException

class ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.applicationdiscovery.model

Class com.amazonaws.services.applicationdiscovery.model.AgentConfigurationStatus

class AgentConfigurationStatus extends Object implements Serializable

Serialized Fields

agentId

String agentId

The agent ID.

description

String description

A description of the operation performed.

operationSucceeded

Boolean operationSucceeded

Information about the status of the StartDataCollection and StopDataCollection operations. The system has recorded the data collection operation. The agent receives this command the next time it polls for a new command.

Class com.amazonaws.services.applicationdiscovery.model.AgentInfo

class AgentInfo extends Object implements Serializable

Serialized Fields

agentId

String agentId

The agent ID.

agentNetworkInfoList

List<AgentNetworkInfo> agentNetworkInfoList

Network details about the host where the agent resides.

connectorId

String connectorId

This data type is currently not valid.

health

String health

The health of the agent.

hostName

String hostName

The name of the host where the agent resides. The host can be a server or virtual machine.

version

String version

The agent version.

Class com.amazonaws.services.applicationdiscovery.model.AgentNetworkInfo

class AgentNetworkInfo extends Object implements Serializable

Serialized Fields

ipAddress

String ipAddress

The IP address for the host where the agent resides.

macAddress

String macAddress

The MAC address for the host where the agent resides.

Exception Class com.amazonaws.services.applicationdiscovery.model.AuthorizationErrorException

class AuthorizationErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationdiscovery.model.ConfigurationTag

class ConfigurationTag extends Object implements Serializable

Serialized Fields

configurationId

String configurationId

The configuration ID for the item you want to tag. You can specify a list of keys and values.

configurationType

String configurationType

A type of IT asset that you want to tag.

key

String key

A type of tag to filter on. For example, serverType.

timeOfCreation

Date timeOfCreation

The time the configuration tag was created in Coordinated Universal Time (UTC).

value

String value

A value to filter on. For example key = serverType and value = web server.

Class com.amazonaws.services.applicationdiscovery.model.CreateTagsRequest

class CreateTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationIds

List<String> configurationIds

A list of configuration items that you want to tag.

tags

List<Tag> tags

Tags that you want to associate with one or more configuration items. Specify the tags that you want to create in a key-value format. For example:

{"key": "serverType", "value": "webServer"}

Class com.amazonaws.services.applicationdiscovery.model.CreateTagsResult

class CreateTagsResult extends Object implements Serializable

Class com.amazonaws.services.applicationdiscovery.model.DeleteTagsRequest

class DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationIds

List<String> configurationIds

A list of configuration items with tags that you want to delete.

tags

List<Tag> tags

Tags that you want to delete from one or more configuration items. Specify the tags that you want to delete in a key-value format. For example:

{"key": "serverType", "value": "webServer"}

Class com.amazonaws.services.applicationdiscovery.model.DeleteTagsResult

class DeleteTagsResult extends Object implements Serializable

Class com.amazonaws.services.applicationdiscovery.model.DescribeAgentsRequest

class DescribeAgentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentIds

List<String> agentIds

The agent IDs for which you want information. If you specify no IDs, the system returns information about all agents associated with your AWS user account.

maxResults

Integer maxResults

The total number of agents to return. The maximum value is 100.

nextToken

String nextToken

A token to start the list. Use this token to get the next set of results.

Class com.amazonaws.services.applicationdiscovery.model.DescribeAgentsResult

class DescribeAgentsResult extends Object implements Serializable

Serialized Fields

agentsInfo

List<AgentInfo> agentsInfo

Lists AWS agents by ID or lists all agents associated with your user account if you did not specify an agent ID. The output includes agent IDs, IP addresses, media access control (MAC) addresses, agent health, host name where the agent resides, and the version number of each agent.

nextToken

String nextToken

The call returns a token. Use this token to get the next set of results.

Class com.amazonaws.services.applicationdiscovery.model.DescribeConfigurationsRequest

class DescribeConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationIds

List<String> configurationIds

One or more configuration IDs.

Class com.amazonaws.services.applicationdiscovery.model.DescribeConfigurationsResult

class DescribeConfigurationsResult extends Object implements Serializable

Serialized Fields

configurations

List<Map<String,String>> configurations

A key in the response map. The value is an array of data.

Class com.amazonaws.services.applicationdiscovery.model.DescribeExportConfigurationsRequest

class DescribeExportConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exportIds

List<String> exportIds

A unique identifier that you can use to query the export status.

maxResults

Integer maxResults

The maximum number of results that you want to display as a part of the query.

nextToken

String nextToken

A token to get the next set of results. For example, if you specified 100 IDs for DescribeConfigurationsRequest$configurationIds but set DescribeExportConfigurationsRequest$maxResults to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.

Class com.amazonaws.services.applicationdiscovery.model.DescribeExportConfigurationsResult

class DescribeExportConfigurationsResult extends Object implements Serializable

Serialized Fields

exportsInfo

List<ExportInfo> exportsInfo

Returns export details. When the status is complete, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.

nextToken

String nextToken

A token to get the next set of results. For example, if you specified 100 IDs for DescribeConfigurationsRequest$configurationIds but set DescribeExportConfigurationsRequest$maxResults to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.

Class com.amazonaws.services.applicationdiscovery.model.DescribeTagsRequest

class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<TagFilter> filters

You can filter the list using a key-value format. You can separate these items by using logical operators. Allowed filters include tagKey, tagValue, and configurationId.

maxResults

Integer maxResults

The total number of items to return. The maximum value is 100.

nextToken

String nextToken

A token to start the list. Use this token to get the next set of results.

Class com.amazonaws.services.applicationdiscovery.model.DescribeTagsResult

class DescribeTagsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The call returns a token. Use this token to get the next set of results.

tags

List<ConfigurationTag> tags

Depending on the input, this is a list of configuration items tagged with a specific tag, or a list of tags for a specific configuration item.

Class com.amazonaws.services.applicationdiscovery.model.ExportConfigurationsRequest

class ExportConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.applicationdiscovery.model.ExportConfigurationsResult

class ExportConfigurationsResult extends Object implements Serializable

Serialized Fields

exportId

String exportId

A unique identifier that you can use to query the export status.

Class com.amazonaws.services.applicationdiscovery.model.ExportInfo

class ExportInfo extends Object implements Serializable

Serialized Fields

configurationsDownloadUrl

String configurationsDownloadUrl

A URL for an Amazon S3 bucket where you can review the configuration data. The URL is displayed only if the export succeeded.

exportId

String exportId

A unique identifier that you can use to query the export.

exportRequestTime

Date exportRequestTime

The time the configuration data export was initiated.

exportStatus

String exportStatus

The status of the configuration data export. The status can succeed, fail, or be in-progress.

statusMessage

String statusMessage

Helpful status messages for API callers. For example: Too many exports in the last 6 hours. Export in progress. Export was successful.

Class com.amazonaws.services.applicationdiscovery.model.Filter

class Filter extends Object implements Serializable

Serialized Fields

condition

String condition

A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

name

String name

The name of the filter. The following filter names are allowed for SERVER configuration items.

Server

• server.hostName

• server.osName

• server.osVersion

• server.configurationid

• server.agentid

The name of the filter. The following filter names are allowed for PROCESS configuration items.

Process

• process.configurationid

• process.name

• process.commandLine

• server.configurationid

• server.hostName

• server.osName

• server.osVersion

• server.agentId

The name of the filter. The following filter names are allowed for CONNECTION configuration items.

Connection

• connection.sourceIp

• connection.destinationIp

• connection.destinationPort

• sourceProcess.configurationId

• sourceProcess.name

• sourceProcess.commandLine

• destinationProcess.configurationId

• destinationProcess.name

• destinationProcess.commandLine

• sourceServer.configurationId

• sourceServer.hostName

• sourceServer.osName

• sourceServer.osVersion

• sourceServer.agentId

• destinationServer.configurationId

• destinationServer.hostName

• destinationServer.osName

• destinationServer.osVersion

• destinationServer.agentId

values

List<String> values

A string value that you want to filter on. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

Exception Class com.amazonaws.services.applicationdiscovery.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.applicationdiscovery.model.InvalidParameterValueException

class InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationdiscovery.model.ListConfigurationsRequest

class ListConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationType

String configurationType

A valid configuration identified by the Discovery Service.

filters

List<Filter> filters

You can filter the list using a key-value format. For example:

{"key": "serverType", "value": "webServer"}

You can separate these items by using logical operators.

maxResults

Integer maxResults

The total number of items to return. The maximum value is 100.

nextToken

String nextToken

A token to start the list. Use this token to get the next set of results.

Class com.amazonaws.services.applicationdiscovery.model.ListConfigurationsResult

class ListConfigurationsResult extends Object implements Serializable

Serialized Fields

configurations

List<Map<String,String>> configurations

Returns configuration details, including the configuration ID, attribute names, and attribute values.

nextToken

String nextToken

The call returns a token. Use this token to get the next set of results.

Exception Class com.amazonaws.services.applicationdiscovery.model.OperationNotPermittedException

class OperationNotPermittedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.applicationdiscovery.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.applicationdiscovery.model.ServerInternalErrorException

class ServerInternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationdiscovery.model.StartDataCollectionByAgentIdsRequest

class StartDataCollectionByAgentIdsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentIds

List<String> agentIds

The IDs of the agents that you want to start collecting data. If you send a request to an AWS agent ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the Description field. If you send a request to multiple agents and you do not have permission to contact some of those agents, the system does not throw an exception. Instead, the system shows Failed in the Description field.

Class com.amazonaws.services.applicationdiscovery.model.StartDataCollectionByAgentIdsResult

class StartDataCollectionByAgentIdsResult extends Object implements Serializable

Serialized Fields

agentsConfigurationStatus

List<AgentConfigurationStatus> agentsConfigurationStatus

Information about agents that were instructed to start collecting data. Information includes the agent ID, a description of the operation performed, and whether or not the agent configuration was updated.

Class com.amazonaws.services.applicationdiscovery.model.StopDataCollectionByAgentIdsRequest

class StopDataCollectionByAgentIdsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

agentIds

List<String> agentIds

The IDs of the agents that you want to stop collecting data.

Class com.amazonaws.services.applicationdiscovery.model.StopDataCollectionByAgentIdsResult

class StopDataCollectionByAgentIdsResult extends Object implements Serializable

Serialized Fields

agentsConfigurationStatus

List<AgentConfigurationStatus> agentsConfigurationStatus

Information about agents that were instructed to stop collecting data. Information includes the agent ID, a description of the operation performed, and whether or not the agent configuration was updated.

Class com.amazonaws.services.applicationdiscovery.model.Tag

class Tag extends Object implements Serializable

Serialized Fields

key

String key

A type of tag to filter on.

value

String value

A value for a tag key to filter on.

Class com.amazonaws.services.applicationdiscovery.model.TagFilter

class TagFilter extends Object implements Serializable

Serialized Fields

name

String name

A name of a tag filter.

values

List<String> values

Values of a tag filter.

Package com.amazonaws.services.autoscaling.model

Class com.amazonaws.services.autoscaling.model.Activity

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

cause

String cause

The reason the activity began.

description

String description

A friendly, more verbose description of the activity.

details

String details

The details about the activity.

endTime

Date endTime

The end time of the activity.

progress

Integer progress

A value between 0 and 100 that indicates the progress of the activity.

startTime

Date startTime

The start 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.

Class com.amazonaws.services.autoscaling.model.AdjustmentType

class 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

class Alarm extends Object implements Serializable

Serialized Fields

alarmARN

String alarmARN

The Amazon Resource Name (ARN) of the alarm.

alarmName

String alarmName

The name of the alarm.

Exception Class com.amazonaws.services.autoscaling.model.AlreadyExistsException

class AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.autoscaling.model.AttachInstancesRequest

class AttachInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.autoscaling.model.AttachInstancesResult

class AttachInstancesResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.AttachLoadBalancersRequest

class AttachLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> loadBalancerNames

One or more load balancer names.

Class com.amazonaws.services.autoscaling.model.AttachLoadBalancersResult

class AttachLoadBalancersResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.AutoScalingGroup

class AutoScalingGroup extends Object implements Serializable

Serialized Fields

autoScalingGroupARN

String autoScalingGroupARN

The Amazon Resource Name (ARN) of the group.

autoScalingGroupName

String autoScalingGroupName

The name of the group.

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

One or more Availability Zones for the group.

createdTime

Date createdTime

The date and time the group was created.

defaultCooldown

Integer defaultCooldown

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

desiredCapacity

Integer desiredCapacity

The desired size of the group.

enabledMetrics

com.amazonaws.internal.SdkInternalList<EnabledMetric> enabledMetrics

The metrics enabled for the group.

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.

healthCheckType

String healthCheckType

The service to use for the health checks. The valid values are EC2 and ELB.

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The EC2 instances associated with the group.

launchConfigurationName

String launchConfigurationName

The name of the associated launch configuration.

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> loadBalancerNames

One or more load balancers associated with the group.

maxSize

Integer maxSize

The maximum size of the group.

minSize

Integer minSize

The minimum size of the group.

newInstancesProtectedFromScaleIn

Boolean newInstancesProtectedFromScaleIn

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

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.

status

String status

The current state of the group when DeleteAutoScalingGroup is in progress.

suspendedProcesses

com.amazonaws.internal.SdkInternalList<SuspendedProcess> suspendedProcesses

The suspended processes associated with the group.

tags

com.amazonaws.internal.SdkInternalList<TagDescription> tags

The tags for the group.

terminationPolicies

com.amazonaws.internal.SdkInternalList<String> terminationPolicies

The termination policies for the group.

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.

Class com.amazonaws.services.autoscaling.model.AutoScalingInstanceDetails

class AutoScalingInstanceDetails extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group associated with the instance.

availabilityZone

String availabilityZone

The Availability Zone for the instance.

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.

instanceId

String instanceId

The ID of the instance.

launchConfigurationName

String launchConfigurationName

The launch configuration associated with the instance.

lifecycleState

String lifecycleState

The lifecycle state for the instance. For more information, see Auto Scaling Lifecycle in the Auto Scaling Developer Guide.

protectedFromScaleIn

Boolean protectedFromScaleIn

Indicates whether the instance is protected from termination by Auto Scaling when scaling in.

Class com.amazonaws.services.autoscaling.model.BlockDeviceMapping

class BlockDeviceMapping extends Object implements Serializable

Serialized Fields

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.

virtualName

String virtualName

The name of the virtual device (for example, ephemeral0).

Class com.amazonaws.services.autoscaling.model.CompleteLifecycleActionRequest

class CompleteLifecycleActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group for the lifecycle hook.

instanceId

String instanceId

The ID of the instance.

lifecycleActionResult

String lifecycleActionResult

The action for the group to take. This parameter can be either CONTINUE or ABANDON.

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.

lifecycleHookName

String lifecycleHookName

The name of the lifecycle hook.

Class com.amazonaws.services.autoscaling.model.CompleteLifecycleActionResult

class CompleteLifecycleActionResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.CreateAutoScalingGroupRequest

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

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

One or more Availability Zones for the group. This parameter is optional if you specify one or more subnets.

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 Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

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.

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

instanceId

String instanceId

The ID of the instance used to create a launch configuration for the group. Alternatively, 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 Using an EC2 Instance in the Auto Scaling Developer Guide.

launchConfigurationName

String launchConfigurationName

The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> loadBalancerNames

One or more load balancers.

For more information, see Using a Load Balancer With an Auto Scaling Group in the Auto Scaling Developer Guide.

maxSize

Integer maxSize

The maximum size of the group.

minSize

Integer minSize

The minimum size of the group.

newInstancesProtectedFromScaleIn

Boolean newInstancesProtectedFromScaleIn

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

One or more tags.

For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling Developer Guide.

terminationPolicies

com.amazonaws.internal.SdkInternalList<String> 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 Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer 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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.

Class com.amazonaws.services.autoscaling.model.CreateAutoScalingGroupResult

class CreateAutoScalingGroupResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.CreateLaunchConfigurationRequest

class CreateLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.

If you specify this parameter, be sure to specify at least one subnet 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.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> 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.

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<String> classicLinkVPCSecurityGroups

The IDs of one or more security groups for the specified ClassicLink-enabled VPC. This parameter is required if you specify a ClassicLink-enabled VPC, and is not supported otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User 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.

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.

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.

instanceId

String instanceId

The ID of the 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.

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 Monitoring Your Auto Scaling Instances and Groups 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.

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.

launchConfigurationName

String launchConfigurationName

The name of the launch configuration. This name must be unique within the scope of your AWS account.

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 this parameter, be sure to specify at least one subnet when you create your group.

For more information, see Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.

Valid values: default | dedicated

ramdiskId

String ramdiskId

The ID of the RAM disk associated with the AMI.

securityGroups

com.amazonaws.internal.SdkInternalList<String> 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.

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 Launching Spot Instances in Your Auto Scaling Group in the Auto Scaling Developer 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.

Class com.amazonaws.services.autoscaling.model.CreateLaunchConfigurationResult

class CreateLaunchConfigurationResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.CreateOrUpdateTagsRequest

class CreateOrUpdateTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

One or more tags.

Class com.amazonaws.services.autoscaling.model.CreateOrUpdateTagsResult

class CreateOrUpdateTagsResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DeleteAutoScalingGroupRequest

class 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.DeleteAutoScalingGroupResult

class DeleteAutoScalingGroupResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DeleteLaunchConfigurationRequest

class DeleteLaunchConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

launchConfigurationName

String launchConfigurationName

The name of the launch configuration.

Class com.amazonaws.services.autoscaling.model.DeleteLaunchConfigurationResult

class DeleteLaunchConfigurationResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DeleteLifecycleHookRequest

class DeleteLifecycleHookRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group for the lifecycle hook.

lifecycleHookName

String lifecycleHookName

The name of the lifecycle hook.

Class com.amazonaws.services.autoscaling.model.DeleteLifecycleHookResult

class DeleteLifecycleHookResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DeleteNotificationConfigurationRequest

class 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.DeleteNotificationConfigurationResult

class DeleteNotificationConfigurationResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DeletePolicyRequest

class 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.DeletePolicyResult

class DeletePolicyResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DeleteScheduledActionRequest

class 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.DeleteScheduledActionResult

class DeleteScheduledActionResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DeleteTagsRequest

class DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

One or more tags.

Class com.amazonaws.services.autoscaling.model.DeleteTagsResult

class DeleteTagsResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsRequest

class DescribeAccountLimitsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeAccountLimitsResult

class 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

class DescribeAdjustmentTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeAdjustmentTypesResult

class DescribeAdjustmentTypesResult extends Object implements Serializable

Serialized Fields

adjustmentTypes

com.amazonaws.internal.SdkInternalList<AdjustmentType> adjustmentTypes

The policy adjustment types.

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingGroupsRequest

class DescribeAutoScalingGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupNames

com.amazonaws.internal.SdkInternalList<String> autoScalingGroupNames

The group names.

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

class DescribeAutoScalingGroupsResult extends Object implements Serializable

Serialized Fields

autoScalingGroups

com.amazonaws.internal.SdkInternalList<AutoScalingGroup> 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

class DescribeAutoScalingInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

The instances to describe; up to 50 instance IDs. 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

class DescribeAutoScalingInstancesResult extends Object implements Serializable

Serialized Fields

autoScalingInstances

com.amazonaws.internal.SdkInternalList<AutoScalingInstanceDetails> 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

class DescribeAutoScalingNotificationTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeAutoScalingNotificationTypesResult

class DescribeAutoScalingNotificationTypesResult extends Object implements Serializable

Serialized Fields

autoScalingNotificationTypes

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeLaunchConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

launchConfigurationNames

com.amazonaws.internal.SdkInternalList<String> launchConfigurationNames

The launch configuration names.

maxRecords

Integer maxRecords

The maximum number of items to return with this call. The default is 100.

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

class DescribeLaunchConfigurationsResult extends Object implements Serializable

Serialized Fields

launchConfigurations

com.amazonaws.internal.SdkInternalList<LaunchConfiguration> 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

class DescribeLifecycleHooksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

lifecycleHookNames

com.amazonaws.internal.SdkInternalList<String> lifecycleHookNames

The names of one or more lifecycle hooks.

Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHooksResult

class DescribeLifecycleHooksResult extends Object implements Serializable

Serialized Fields

lifecycleHooks

com.amazonaws.internal.SdkInternalList<LifecycleHook> lifecycleHooks

The lifecycle hooks for the specified group.

Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHookTypesRequest

class DescribeLifecycleHookTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeLifecycleHookTypesResult

class DescribeLifecycleHookTypesResult extends Object implements Serializable

Serialized Fields

lifecycleHookTypes

com.amazonaws.internal.SdkInternalList<String> lifecycleHookTypes

One or more of the following notification types:

• autoscaling:EC2_INSTANCE_LAUNCHING

• autoscaling:EC2_INSTANCE_TERMINATING

Class com.amazonaws.services.autoscaling.model.DescribeLoadBalancersRequest

class DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

class DescribeLoadBalancersResult extends Object implements Serializable

Serialized Fields

loadBalancers

com.amazonaws.internal.SdkInternalList<LoadBalancerState> 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

class DescribeMetricCollectionTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeMetricCollectionTypesResult

class DescribeMetricCollectionTypesResult extends Object implements Serializable

Serialized Fields

granularities

com.amazonaws.internal.SdkInternalList<MetricGranularityType> granularities

The granularities for the metrics.

metrics

com.amazonaws.internal.SdkInternalList<MetricCollectionType> metrics

One or more metrics.

Class com.amazonaws.services.autoscaling.model.DescribeNotificationConfigurationsRequest

class DescribeNotificationConfigurationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupNames

com.amazonaws.internal.SdkInternalList<String> autoScalingGroupNames

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

class DescribeNotificationConfigurationsResult extends Object implements Serializable

Serialized Fields

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.

notificationConfigurations

com.amazonaws.internal.SdkInternalList<NotificationConfiguration> notificationConfigurations

The notification configurations.

Class com.amazonaws.services.autoscaling.model.DescribePoliciesRequest

class DescribePoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

maxRecords

Integer maxRecords

The maximum number of items to be returned with each call.

nextToken

String nextToken

The token for the next set of items to return. (You received this token from a previous call.)

policyNames

com.amazonaws.internal.SdkInternalList<String> 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<String> policyTypes

One or more policy types. Valid values are SimpleScaling and StepScaling.

Class com.amazonaws.services.autoscaling.model.DescribePoliciesResult

class DescribePoliciesResult extends Object implements Serializable

Serialized Fields

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.

scalingPolicies

com.amazonaws.internal.SdkInternalList<ScalingPolicy> scalingPolicies

The scaling policies.

Class com.amazonaws.services.autoscaling.model.DescribeScalingActivitiesRequest

class DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

activityIds

com.amazonaws.internal.SdkInternalList<String> activityIds

The activity IDs of the desired scaling activities. If this list is omitted, all activities are described. If you specify an Auto Scaling group, 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

class DescribeScalingActivitiesResult extends Object implements Serializable

Serialized Fields

activities

com.amazonaws.internal.SdkInternalList<Activity> 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

class DescribeScalingProcessTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeScalingProcessTypesResult

class DescribeScalingProcessTypesResult extends Object implements Serializable

Serialized Fields

processes

com.amazonaws.internal.SdkInternalList<ProcessType> processes

The names of the process types.

Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsRequest

class DescribeScheduledActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

endTime

Date endTime

The latest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

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

scheduledActionNames

com.amazonaws.internal.SdkInternalList<String> 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.

startTime

Date startTime

The earliest scheduled start time to return. If scheduled action names are provided, this parameter is ignored.

Class com.amazonaws.services.autoscaling.model.DescribeScheduledActionsResult

class DescribeScheduledActionsResult extends Object implements Serializable

Serialized Fields

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.

scheduledUpdateGroupActions

com.amazonaws.internal.SdkInternalList<ScheduledUpdateGroupAction> scheduledUpdateGroupActions

The scheduled actions.

Class com.amazonaws.services.autoscaling.model.DescribeTagsRequest

class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

A filter used to scope the tags to return.

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

class DescribeTagsResult extends Object implements Serializable

Serialized Fields

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.

tags

com.amazonaws.internal.SdkInternalList<TagDescription> tags

One or more tags.

Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesRequest

class DescribeTerminationPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.autoscaling.model.DescribeTerminationPolicyTypesResult

class DescribeTerminationPolicyTypesResult extends Object implements Serializable

Serialized Fields

terminationPolicyTypes

com.amazonaws.internal.SdkInternalList<String> terminationPolicyTypes

The termination policies supported by Auto Scaling ( OldestInstance, OldestLaunchConfiguration, NewestInstance, ClosestToNextInstanceHour, and Default).

Class com.amazonaws.services.autoscaling.model.DetachInstancesRequest

class DetachInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

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

class DetachInstancesResult extends Object implements Serializable

Serialized Fields

activities

com.amazonaws.internal.SdkInternalList<Activity> activities

The activities related to detaching the instances from the Auto Scaling group.

Class com.amazonaws.services.autoscaling.model.DetachLoadBalancersRequest

class DetachLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> loadBalancerNames

One or more load balancer names.

Class com.amazonaws.services.autoscaling.model.DetachLoadBalancersResult

class DetachLoadBalancersResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.DisableMetricsCollectionRequest

class 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<String> 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.DisableMetricsCollectionResult

class DisableMetricsCollectionResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.Ebs

class Ebs extends Object implements Serializable

Serialized Fields

deleteOnTermination

Boolean deleteOnTermination

Indicates whether the volume is deleted on instance termination.

Default: true

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.

iops

Integer iops

The number of I/O operations per second (IOPS) to provision for the volume.

Constraint: Required when the volume type is io1.

snapshotId

String snapshotId

The ID of the snapshot.

volumeSize

Integer volumeSize

The volume size, in GiB. For standard volumes, specify a value from 1 to 1,024. For io1 volumes, specify a value from 4 to 16,384. For gp2 volumes, specify a value from 1 to 16,384. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.

volumeType

String volumeType

The volume type. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Valid values: standard | io1 | gp2

Default: standard

Class com.amazonaws.services.autoscaling.model.EnabledMetric

class EnabledMetric extends Object implements Serializable

Serialized Fields

granularity

String granularity

The granularity of the metric. The only valid value is 1Minute.

metric

String metric

One of the following metrics:

• GroupMinSize

• GroupMaxSize

• GroupDesiredCapacity

• GroupInServiceInstances

• GroupPendingInstances

• GroupStandbyInstances

• GroupTerminatingInstances

• GroupTotalInstances

Class com.amazonaws.services.autoscaling.model.EnableMetricsCollectionRequest

class EnableMetricsCollectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or ARN of the Auto Scaling group.

granularity

String granularity

The granularity to associate with the metrics to collect. The only valid value is 1Minute.

metrics

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.autoscaling.model.EnableMetricsCollectionResult

class EnableMetricsCollectionResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.EnterStandbyRequest

class EnterStandbyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instances to move into Standby mode. You must specify at least one instance ID.

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

class EnterStandbyResult extends Object implements Serializable

Serialized Fields

activities

com.amazonaws.internal.SdkInternalList<Activity> activities

The activities related to moving instances into Standby mode.

Class com.amazonaws.services.autoscaling.model.ExecutePolicyRequest

class ExecutePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

breachThreshold

Double breachThreshold

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

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

policyName

String policyName

The name or ARN of the policy.

Class com.amazonaws.services.autoscaling.model.ExecutePolicyResult

class ExecutePolicyResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.ExitStandbyRequest

class ExitStandbyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs. You must specify at least one instance ID.

Class com.amazonaws.services.autoscaling.model.ExitStandbyResult

class ExitStandbyResult extends Object implements Serializable

Serialized Fields

activities

com.amazonaws.internal.SdkInternalList<Activity> activities

The activities related to moving instances out of Standby mode.

Class com.amazonaws.services.autoscaling.model.Filter

class 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<String> values

The value of the filter.

Class com.amazonaws.services.autoscaling.model.Instance

class Instance extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone in which the instance is running.

healthStatus

String healthStatus

The health status of the 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.

instanceId

String instanceId

The ID of the instance.

launchConfigurationName

String launchConfigurationName

The launch configuration associated with the instance.

lifecycleState

String lifecycleState

A description of the current lifecycle state. Note that the Quarantined state is not used.

protectedFromScaleIn

Boolean protectedFromScaleIn

Indicates whether the instance is protected from termination by Auto Scaling when scaling in.

Class com.amazonaws.services.autoscaling.model.InstanceMonitoring

class InstanceMonitoring extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

If True, instance monitoring is enabled.

Exception Class com.amazonaws.services.autoscaling.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.autoscaling.model.LaunchConfiguration

class LaunchConfiguration extends Object implements Serializable

Serialized Fields

associatePublicIpAddress

Boolean associatePublicIpAddress

[EC2-VPC] Indicates whether to assign a public IP address to each instance.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> blockDeviceMappings

A block device mapping, which specifies the block devices for the instance.

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<String> classicLinkVPCSecurityGroups

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId. This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.

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

iamInstanceProfile

String iamInstanceProfile

The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

imageId

String imageId

The ID of the Amazon Machine Image (AMI).

instanceMonitoring

InstanceMonitoring instanceMonitoring

Controls whether instances in this group are launched with detailed monitoring.

instanceType

String instanceType

The instance type for the instances.

kernelId

String kernelId

The ID of the kernel associated with the AMI.

keyName

String keyName

The name of the key pair.

launchConfigurationARN

String launchConfigurationARN

The Amazon Resource Name (ARN) of the launch configuration.

launchConfigurationName

String launchConfigurationName

The name of the launch configuration.

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.

ramdiskId

String ramdiskId

The ID of the RAM disk associated with the AMI.

securityGroups

com.amazonaws.internal.SdkInternalList<String> securityGroups

The security groups to associate with the instances.

spotPrice

String spotPrice

The price to bid when launching Spot Instances.

userData

String userData

The user data available to the instances.

Class com.amazonaws.services.autoscaling.model.LifecycleHook

class LifecycleHook extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group for the lifecycle hook.

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.

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

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 default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat.

lifecycleHookName

String lifecycleHookName

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

notificationMetadata

String notificationMetadata

Additional information that you want to include any time Auto Scaling sends a message to the notification target.

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.

Exception Class com.amazonaws.services.autoscaling.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.autoscaling.model.LoadBalancerState

class 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

class 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

class 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

class NotificationConfiguration extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

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

topicARN

String topicARN

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

Class com.amazonaws.services.autoscaling.model.ProcessType

class 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

class PutLifecycleHookRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group to which you want to assign the lifecycle hook.

defaultResult

String defaultResult

Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either CONTINUE or ABANDON. The default value is ABANDON.

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 default action. You can prevent the lifecycle hook from timing out by calling RecordLifecycleActionHeartbeat. The default is 3600 seconds (1 hour).

lifecycleHookName

String lifecycleHookName

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

notificationMetadata

String notificationMetadata

Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.

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 target can be either an SQS queue or an SNS topic. If you specify an empty string, this overrides the current ARN.

The notification messages sent to the target include the following information:

• AutoScalingGroupName. The name of the Auto Scaling group.
• AccountId. The AWS account ID.
• LifecycleTransition. The lifecycle hook type.
• LifecycleActionToken. The lifecycle action token.
• EC2InstanceId. The EC2 instance ID.
• LifecycleHookName. The name of the lifecycle hook.
• NotificationMetadata. User-defined information.

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 specify a notification target, Auto Scaling sends it a test message. Test messages contains the following additional key/value pair: "Event": "autoscaling:TEST_NOTIFICATION".

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.

Class com.amazonaws.services.autoscaling.model.PutLifecycleHookResult

class PutLifecycleHookResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.PutNotificationConfigurationRequest

class PutNotificationConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

notificationTypes

com.amazonaws.internal.SdkInternalList<String> notificationTypes

The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see DescribeAutoScalingNotificationTypes.

topicARN

String topicARN

The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.

Class com.amazonaws.services.autoscaling.model.PutNotificationConfigurationResult

class PutNotificationConfigurationResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.PutScalingPolicyRequest

class PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

autoScalingGroupName

String autoScalingGroupName

The name or ARN of the group.

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 Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

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.

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.

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.

minAdjustmentStep

Integer minAdjustmentStep

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

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.

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.

stepAdjustments

com.amazonaws.internal.SdkInternalList<StepAdjustment> 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.

Class com.amazonaws.services.autoscaling.model.PutScalingPolicyResult

class 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

class PutScheduledUpdateGroupActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

desiredCapacity

Integer desiredCapacity

The number of EC2 instances that should be running in the group.

endTime

Date endTime

The time for this action to end.

maxSize

Integer maxSize

The maximum size for the Auto Scaling group.

minSize

Integer minSize

The minimum size for the Auto Scaling group.

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.

scheduledActionName

String scheduledActionName

The name of this scaling action.

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.

time

Date time

This parameter is deprecated.

Class com.amazonaws.services.autoscaling.model.PutScheduledUpdateGroupActionResult

class PutScheduledUpdateGroupActionResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.RecordLifecycleActionHeartbeatRequest

class RecordLifecycleActionHeartbeatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group for the hook.

instanceId

String instanceId

The ID of the instance.

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.

lifecycleHookName

String lifecycleHookName

The name of the lifecycle hook.

Class com.amazonaws.services.autoscaling.model.RecordLifecycleActionHeartbeatResult

class RecordLifecycleActionHeartbeatResult extends Object implements Serializable

Exception Class com.amazonaws.services.autoscaling.model.ResourceContentionException

class ResourceContentionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.autoscaling.model.ResourceInUseException

class ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.autoscaling.model.ResumeProcessesRequest

class 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<String> scalingProcesses

One or more of the following processes:

• Launch

• Terminate

• HealthCheck

• ReplaceUnhealthy

• AZRebalance

• AlarmNotification

• ScheduledActions

• AddToLoadBalancer

Class com.amazonaws.services.autoscaling.model.ResumeProcessesResult

class ResumeProcessesResult extends Object implements Serializable

Exception Class com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException

class ScalingActivityInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.autoscaling.model.ScalingPolicy

class ScalingPolicy extends Object implements Serializable

Serialized Fields

adjustmentType

String adjustmentType

The adjustment type, which specifies how ScalingAdjustment is interpreted. Valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

alarms

com.amazonaws.internal.SdkInternalList<Alarm> alarms

The CloudWatch alarms related to the policy.

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group associated with this scaling policy.

cooldown

Integer cooldown

The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.

estimatedInstanceWarmup

Integer estimatedInstanceWarmup

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics.

metricAggregationType

String metricAggregationType

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

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.

minAdjustmentStep

Integer minAdjustmentStep

Available for backward compatibility. Use MinAdjustmentMagnitude instead.

policyARN

String policyARN

The Amazon Resource Name (ARN) of the policy.

policyName

String policyName

The name of the scaling policy.

policyType

String policyType

The policy type. Valid values are SimpleScaling and StepScaling.

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.

stepAdjustments

com.amazonaws.internal.SdkInternalList<StepAdjustment> stepAdjustments

A set of adjustments that enable you to scale based on the size of the alarm breach.

Class com.amazonaws.services.autoscaling.model.ScheduledUpdateGroupAction

class ScheduledUpdateGroupAction extends Object implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

desiredCapacity

Integer desiredCapacity

The number of instances you prefer to maintain in the group.

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.

maxSize

Integer maxSize

The maximum size of the group.

minSize

Integer minSize

The minimum size of the group.

recurrence

String recurrence

The recurring schedule for the action.

scheduledActionARN

String scheduledActionARN

The Amazon Resource Name (ARN) of the scheduled action.

scheduledActionName

String scheduledActionName

The name of the scheduled action.

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.

time

Date time

This parameter is deprecated.

Class com.amazonaws.services.autoscaling.model.SetDesiredCapacityRequest

class 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.SetDesiredCapacityResult

class SetDesiredCapacityResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.SetInstanceHealthRequest

class SetInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

instanceId

String instanceId

The ID of the 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 description of the health check grace period for CreateAutoScalingGroup.

Class com.amazonaws.services.autoscaling.model.SetInstanceHealthResult

class SetInstanceHealthResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.SetInstanceProtectionRequest

class SetInstanceProtectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the group.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

protectedFromScaleIn

Boolean protectedFromScaleIn

Indicates whether the instance is protected from termination by Auto Scaling when scaling in.

Class com.amazonaws.services.autoscaling.model.SetInstanceProtectionResult

class SetInstanceProtectionResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.StepAdjustment

class 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

class 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

class 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<String> scalingProcesses

One or more of the following processes:

• Launch

• Terminate

• HealthCheck

• ReplaceUnhealthy

• AZRebalance

• AlarmNotification

• ScheduledActions

• AddToLoadBalancer

Class com.amazonaws.services.autoscaling.model.SuspendProcessesResult

class SuspendProcessesResult extends Object implements Serializable

Class com.amazonaws.services.autoscaling.model.Tag

class Tag extends Object implements Serializable

Serialized Fields

key

String key

The tag key.

propagateAtLaunch

Boolean propagateAtLaunch

Determines whether the tag is added to new instances as they are launched in the group.

resourceId

String resourceId

The name of the group.

resourceType

String resourceType

The type of resource. The only supported value is auto-scaling-group.

value

String value

The tag value.

Class com.amazonaws.services.autoscaling.model.TagDescription

class TagDescription extends Object implements Serializable

Serialized Fields

key

String key

The tag key.

propagateAtLaunch

Boolean propagateAtLaunch

Determines whether the tag is added to new instances as they are launched in the group.

resourceId

String resourceId

The name of the group.

resourceType

String resourceType

The type of resource. The only supported value is auto-scaling-group.

value

String value

The tag value.

Class com.amazonaws.services.autoscaling.model.TerminateInstanceInAutoScalingGroupRequest

class TerminateInstanceInAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the 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

class TerminateInstanceInAutoScalingGroupResult extends Object implements Serializable

Serialized Fields

activity

Activity activity

A scaling activity.

Class com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupRequest

class UpdateAutoScalingGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingGroupName

String autoScalingGroupName

The name of the Auto Scaling group.

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

One or more Availability Zones for 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 Auto Scaling Cooldowns in the Auto Scaling Developer Guide.

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.

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 in the Auto Scaling Developer Guide.

healthCheckType

String healthCheckType

The service to use for the health checks. The valid values are EC2 and ELB.

launchConfigurationName

String launchConfigurationName

The name of the launch configuration.

maxSize

Integer maxSize

The maximum size of the Auto Scaling group.

minSize

Integer minSize

The minimum size of the Auto Scaling group.

newInstancesProtectedFromScaleIn

Boolean newInstancesProtectedFromScaleIn

Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.

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.

terminationPolicies

com.amazonaws.internal.SdkInternalList<String> 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 Controlling Which Instances Auto Scaling Terminates During Scale In in the Auto Scaling Developer 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 Launching Auto Scaling Instances in a VPC in the Auto Scaling Developer Guide.

Class com.amazonaws.services.autoscaling.model.UpdateAutoScalingGroupResult

class UpdateAutoScalingGroupResult extends Object implements Serializable

Package com.amazonaws.services.certificatemanager.model

Class com.amazonaws.services.certificatemanager.model.AddTagsToCertificateRequest

class AddTagsToCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateArn

String certificateArn

String that contains the ARN of the ACM Certificate to which the tag is to be applied. 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.

tags

List<Tag> tags

The key-value pair that defines the tag. The tag value is optional.

Class com.amazonaws.services.certificatemanager.model.AddTagsToCertificateResult

class AddTagsToCertificateResult extends Object implements Serializable

Class com.amazonaws.services.certificatemanager.model.CertificateDetail

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

createdAt

Date createdAt

Time at which the certificate was requested.

domainName

String domainName

Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

domainValidationOptions

List<DomainValidation> domainValidationOptions

References a DomainValidation structure that contains the domain name in the certificate and the email address that can be used for validation.

inUseBy

List<String> inUseBy

List that identifies ARNs that are using the certificate. A single ACM Certificate can be used by multiple AWS resources.

issuedAt

Date issuedAt

Time at which the certificate was issued.

issuer

String issuer

The X.500 distinguished name of the CA that issued and signed the certificate.

keyAlgorithm

String keyAlgorithm

Asymmetric algorithm used to generate the public and private key pair. Currently the only supported value is RSA_2048.

notAfter

Date notAfter

Time after which the certificate is not valid.

notBefore

Date notBefore

Time before which the certificate is not valid.

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

revokedAt

Date revokedAt

The time, if any, at which the certificate was revoked. This value exists only if the certificate has been revoked.

serial

String serial

String that contains the serial number of the certificate.

signatureAlgorithm

String signatureAlgorithm

Algorithm used to generate a signature. Currently the only supported value is SHA256WITHRSA.

status

String status

A CertificateStatus enumeration value that can contain one of the following:

• PENDING_VALIDATION

• ISSUED

• INACTIVE

• EXPIRED

• REVOKED

• FAILED

• VALIDATION_TIMED_OUT

subject

String subject

The X.500 distinguished name of the entity associated with the public key contained in the certificate.

subjectAlternativeNames

List<String> 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.

Class com.amazonaws.services.certificatemanager.model.CertificateSummary

class 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

class 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.DeleteCertificateResult

class DeleteCertificateResult extends Object implements Serializable

Class com.amazonaws.services.certificatemanager.model.DescribeCertificateRequest

class 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

class 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

class DomainValidation extends Object implements Serializable

Serialized Fields

domainName

String domainName

Fully Qualified Domain Name (FQDN) of the form www.example.com or example.com

validationDomain

String validationDomain

The base validation domain that acts as the suffix of the email addresses that are used to send the emails.

validationEmails

List<String> validationEmails

A list of contact address for the domain registrant.

Class com.amazonaws.services.certificatemanager.model.DomainValidationOption

class 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:

• admin@subdomain.example.com

• administrator@subdomain.example.com

• hostmaster@subdomain.example.com

• postmaster@subdomain.example.com

• webmaster@subdomain.example.com

Class com.amazonaws.services.certificatemanager.model.GetCertificateRequest

class 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

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

Exception Class com.amazonaws.services.certificatemanager.model.InvalidArnException

class InvalidArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.certificatemanager.model.InvalidDomainValidationOptionsException

class InvalidDomainValidationOptionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.certificatemanager.model.InvalidStateException

class InvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.certificatemanager.model.InvalidTagException

class InvalidTagException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.certificatemanager.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.certificatemanager.model.ListCertificatesRequest

class ListCertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateStatuses

List<String> 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

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.

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.

Class com.amazonaws.services.certificatemanager.model.ListCertificatesResult

class ListCertificatesResult extends Object implements Serializable

Serialized Fields

certificateSummaryList

List<CertificateSummary> certificateSummaryList

A list of the certificate ARNs.

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.

Class com.amazonaws.services.certificatemanager.model.ListTagsForCertificateRequest

class ListTagsForCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateArn

String certificateArn

String that contains the ARN of the ACM Certificate for which you want to list the tags. 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.ListTagsForCertificateResult

class ListTagsForCertificateResult extends Object implements Serializable

Serialized Fields

tags

List<Tag> tags

The key-value pairs that define the applied tags.

Class com.amazonaws.services.certificatemanager.model.RemoveTagsFromCertificateRequest

class RemoveTagsFromCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateArn

String certificateArn

String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. 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.

tags

List<Tag> tags

The key-value pair that defines the tag to remove.

Class com.amazonaws.services.certificatemanager.model.RemoveTagsFromCertificateResult

class RemoveTagsFromCertificateResult extends Object implements Serializable

Class com.amazonaws.services.certificatemanager.model.RequestCertificateRequest

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

domainValidationOptions

List<DomainValidationOption> 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:

• admin@example.com

• administrator@example.com

• hostmaster@example.com

• postmaster@example.com

• webmaster@example.com

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.

subjectAlternativeNames

List<String> 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.

Class com.amazonaws.services.certificatemanager.model.RequestCertificateResult

class 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

Exception Class com.amazonaws.services.certificatemanager.model.RequestInProgressException

class RequestInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.certificatemanager.model.ResendValidationEmailRequest

class 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 the RequestCertificate action 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:

• admin@subdomain.example.com

• administrator@subdomain.example.com

• hostmaster@subdomain.example.com

• postmaster@subdomain.example.com

• webmaster@subdomain.example.com

Class com.amazonaws.services.certificatemanager.model.ResendValidationEmailResult

class ResendValidationEmailResult extends Object implements Serializable

Exception Class com.amazonaws.services.certificatemanager.model.ResourceInUseException

class ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.certificatemanager.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.certificatemanager.model.Tag

class Tag extends Object implements Serializable

Serialized Fields

key

String key

The key of the tag.

value

String value

The value of the tag.

Exception Class com.amazonaws.services.certificatemanager.model.TooManyTagsException

class TooManyTagsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.cloudformation.model

Class com.amazonaws.services.cloudformation.model.AccountLimit

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

Exception Class com.amazonaws.services.cloudformation.model.AlreadyExistsException

class AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudformation.model.CancelUpdateStackRequest

class 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.CancelUpdateStackResult

class CancelUpdateStackResult extends Object implements Serializable

Class com.amazonaws.services.cloudformation.model.Change

class Change extends Object implements Serializable

Serialized Fields

resourceChange

ResourceChange resourceChange

A ResourceChange structure that describes the resource and action that AWS CloudFormation will perform.

type

String type

The type of entity that AWS CloudFormation changes. Currently, the only entity type is Resource.

Exception Class com.amazonaws.services.cloudformation.model.ChangeSetNotFoundException

class ChangeSetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudformation.model.ChangeSetSummary

class ChangeSetSummary extends Object implements Serializable

Serialized Fields

changeSetId

String changeSetId

The ID of the change set.

changeSetName

String changeSetName

The name of the change set.

creationTime

Date creationTime

The start time when the change set was created, in UTC.

description

String description

Descriptive information about the change set.

executionStatus

String executionStatus

If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

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.

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.

Class com.amazonaws.services.cloudformation.model.ContinueUpdateRollbackRequest

class 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

class ContinueUpdateRollbackResult extends Object implements Serializable

Class com.amazonaws.services.cloudformation.model.CreateChangeSetRequest

class CreateChangeSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

capabilities

com.amazonaws.internal.SdkInternalList<String> 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.

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.

notificationARNs

com.amazonaws.internal.SdkInternalList<String> 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.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of Parameter structures that specify input parameters for the change set. For more information, see the Parameter data type.

resourceTypes

com.amazonaws.internal.SdkInternalList<String> 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.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.

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.

Class com.amazonaws.services.cloudformation.model.CreateChangeSetResult

class 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

class CreateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

capabilities

com.amazonaws.internal.SdkInternalList<String> 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.

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

notificationARNs

com.amazonaws.internal.SdkInternalList<String> 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).

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

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

resourceTypes

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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

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.

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.

Class com.amazonaws.services.cloudformation.model.CreateStackResult

class CreateStackResult extends Object implements Serializable

Serialized Fields

stackId

String stackId

Unique identifier of the stack.

Class com.amazonaws.services.cloudformation.model.DeleteChangeSetRequest

class 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

class DeleteChangeSetResult extends Object implements Serializable

Class com.amazonaws.services.cloudformation.model.DeleteStackRequest

class DeleteStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

retainResources

com.amazonaws.internal.SdkInternalList<String> 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.

stackName

String stackName

The name or the unique stack ID that is associated with the stack.

Class com.amazonaws.services.cloudformation.model.DeleteStackResult

class DeleteStackResult extends Object implements Serializable

Class com.amazonaws.services.cloudformation.model.DescribeAccountLimitsRequest

class 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

class DescribeAccountLimitsResult extends Object implements Serializable

Serialized Fields

accountLimits

com.amazonaws.internal.SdkInternalList<AccountLimit> 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

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

nextToken

String nextToken

A string (provided by the DescribeChangeSet response output) that identifies the next page of information that you want to retrieve.

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.

Class com.amazonaws.services.cloudformation.model.DescribeChangeSetResult

class DescribeChangeSetResult extends Object implements Serializable

Serialized Fields

capabilities

com.amazonaws.internal.SdkInternalList<String> capabilities

If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.

changes

com.amazonaws.internal.SdkInternalList<Change> changes

A list of Change structures that describes the resources AWS CloudFormation changes if you execute the change set.

changeSetId

String changeSetId

The ARN of the change set.

changeSetName

String changeSetName

The name of the change set.

creationTime

Date creationTime

The start time when the change set was created, in UTC.

description

String description

Information about the change set.

executionStatus

String executionStatus

If the change set execution status is AVAILABLE, you can execute the change set. If you can’t execute the change set, the status indicates why. For example, a change set might be in an UNAVAILABLE state because AWS CloudFormation is still creating it or in an OBSOLETE state because the stack was already updated.

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.

notificationARNs

com.amazonaws.internal.SdkInternalList<String> 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.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> 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.

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.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

If you execute the change set, the tags that will be associated with the stack.

Class com.amazonaws.services.cloudformation.model.DescribeStackEventsRequest

class DescribeStackEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

A string that identifies the next page of events that you want to retrieve.

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

class DescribeStackEventsResult extends Object implements Serializable

Serialized Fields

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.

stackEvents

com.amazonaws.internal.SdkInternalList<StackEvent> stackEvents

A list of StackEvents structures.

Class com.amazonaws.services.cloudformation.model.DescribeStackResourceRequest

class DescribeStackResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logicalResourceId

String logicalResourceId

The logical name of the resource as specified in the template.

Default: There is no default value.

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

class 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

class DescribeStackResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.cloudformation.model.DescribeStackResourcesResult

class DescribeStackResourcesResult extends Object implements Serializable

Serialized Fields

stackResources

com.amazonaws.internal.SdkInternalList<StackResource> stackResources

A list of StackResource structures.

Class com.amazonaws.services.cloudformation.model.DescribeStacksRequest

class DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

A string that identifies the next page of stacks that you want to retrieve.

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

class DescribeStacksResult extends Object implements Serializable

Serialized Fields

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.

stacks

com.amazonaws.internal.SdkInternalList<Stack> stacks

A list of stack structures.

Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostRequest

class EstimateTemplateCostRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of Parameter structures that specify input parameters.

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.

Class com.amazonaws.services.cloudformation.model.EstimateTemplateCostResult

class 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

class 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

class ExecuteChangeSetResult extends Object implements Serializable

Class com.amazonaws.services.cloudformation.model.GetStackPolicyRequest

class 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

class 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

class 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

class 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

class GetTemplateSummaryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.cloudformation.model.GetTemplateSummaryResult

class GetTemplateSummaryResult extends Object implements Serializable

Serialized Fields

capabilities

com.amazonaws.internal.SdkInternalList<String> 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.

description

String description

The value that is defined in the Description property of the template.

metadata

String metadata

The value that is defined for the Metadata property of the template.

parameters

com.amazonaws.internal.SdkInternalList<ParameterDeclaration> parameters

A list of parameter declarations that describe various properties for each parameter.

resourceTypes

com.amazonaws.internal.SdkInternalList<String> 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.

Exception Class com.amazonaws.services.cloudformation.model.InsufficientCapabilitiesException

class InsufficientCapabilitiesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudformation.model.InvalidChangeSetStatusException

class InvalidChangeSetStatusException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudformation.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudformation.model.ListChangeSetsRequest

class ListChangeSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

A string (provided by the ListChangeSets response output) that identifies the next page of change sets that you want to retrieve.

stackName

String stackName

The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.

Class com.amazonaws.services.cloudformation.model.ListChangeSetsResult

class ListChangeSetsResult extends Object implements Serializable

Serialized Fields

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.

summaries

com.amazonaws.internal.SdkInternalList<ChangeSetSummary> summaries

A list of ChangeSetSummary structures that provides the ID and status of each change set for the specified stack.

Class com.amazonaws.services.cloudformation.model.ListStackResourcesRequest

class ListStackResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

A string that identifies the next page of stack resources that you want to retrieve.

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

class ListStackResourcesResult extends Object implements Serializable

Serialized Fields

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.

stackResourceSummaries

com.amazonaws.internal.SdkInternalList<StackResourceSummary> stackResourceSummaries

A list of StackResourceSummary structures.

Class com.amazonaws.services.cloudformation.model.ListStacksRequest

class 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<String> 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

class ListStacksResult extends Object implements Serializable

Serialized Fields

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.

stackSummaries

com.amazonaws.internal.SdkInternalList<StackSummary> stackSummaries

A list of StackSummary structures containing information about the specified stacks.

Class com.amazonaws.services.cloudformation.model.Output

class Output extends Object implements Serializable

Serialized Fields

description

String description

User defined description associated with the output.

outputKey

String outputKey

The key associated with the output.

outputValue

String outputValue

The value associated with the output.

Class com.amazonaws.services.cloudformation.model.Parameter

class 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

class ParameterConstraints extends Object implements Serializable

Serialized Fields

allowedValues

com.amazonaws.internal.SdkInternalList<String> allowedValues

A list of values that are permitted for a parameter.

Class com.amazonaws.services.cloudformation.model.ParameterDeclaration

class ParameterDeclaration extends Object implements Serializable

Serialized Fields

defaultValue

String defaultValue

The default value of the parameter.

description

String description

The description that is associate with the parameter.

noEcho

Boolean noEcho

Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.

parameterConstraints

ParameterConstraints parameterConstraints

The criteria that AWS CloudFormation uses to validate parameter values.

parameterKey

String parameterKey

The name that is associated with the parameter.

parameterType

String parameterType

The type of parameter.

Class com.amazonaws.services.cloudformation.model.ResourceChange

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

details

com.amazonaws.internal.SdkInternalList<ResourceChangeDetail> details

For the Modify action, a list of ResourceChangeDetail structures that describes the changes that AWS CloudFormation will make to the 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.

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.

resourceType

String resourceType

The type of AWS CloudFormation resource, such as AWS::S3::Bucket.

scope

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.cloudformation.model.ResourceChangeDetail

class ResourceChangeDetail extends Object implements Serializable

Serialized Fields

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.

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.

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.

target

ResourceTargetDefinition target

A ResourceTargetDefinition structure that describes the field that AWS CloudFormation will change and whether the resource will be recreated.

Class com.amazonaws.services.cloudformation.model.ResourceTargetDefinition

class 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

class 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.SetStackPolicyResult

class SetStackPolicyResult extends Object implements Serializable

Class com.amazonaws.services.cloudformation.model.SignalResourceRequest

class SignalResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

stackName

String stackName

The stack name or unique stack ID that includes the resource that you want to signal.

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.

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.

Class com.amazonaws.services.cloudformation.model.SignalResourceResult

class SignalResourceResult extends Object implements Serializable

Class com.amazonaws.services.cloudformation.model.Stack

class Stack extends Object implements Serializable

Serialized Fields

capabilities

com.amazonaws.internal.SdkInternalList<String> capabilities

The capabilities allowed in the stack.

creationTime

Date creationTime

The time at which the stack was created.

description

String description

A user-defined description associated with the stack.

disableRollback

Boolean disableRollback

Boolean to enable or disable rollback on stack creation failures:

• true: disable rollback

• false: enable rollback

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.

notificationARNs

com.amazonaws.internal.SdkInternalList<String> notificationARNs

SNS topic ARNs to which stack related events are published.

outputs

com.amazonaws.internal.SdkInternalList<Output> outputs

A list of output structures.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of Parameter structures.

stackId

String stackId

Unique identifier of the stack.

stackName

String stackName

The name associated with the stack.

stackStatus

String stackStatus

Current status of the stack.

stackStatusReason

String stackStatusReason

Success/failure message associated with the stack status.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

A list of Tags that specify information about the stack.

timeoutInMinutes

Integer timeoutInMinutes

The amount of time within which stack creation should complete.

Class com.amazonaws.services.cloudformation.model.StackEvent

class StackEvent extends Object implements Serializable

Serialized Fields

eventId

String eventId

The unique ID of this event.

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.

resourceProperties

String resourceProperties

BLOB of the properties used to create the resource.

resourceStatus

String resourceStatus

Current status of the resource.

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

resourceType

String resourceType

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

stackId

String stackId

The unique ID name of the instance of the stack.

stackName

String stackName

The name associated with a stack.

timestamp

Date timestamp

Time the status was updated.

Class com.amazonaws.services.cloudformation.model.StackResource

class StackResource extends Object implements Serializable

Serialized Fields

description

String description

User defined description associated with the resource.

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.

resourceStatus

String resourceStatus

Current status of the resource.

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

resourceType

String resourceType

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

stackId

String stackId

Unique identifier of the stack.

stackName

String stackName

The name associated with the stack.

timestamp

Date timestamp

Time the status was updated.

Class com.amazonaws.services.cloudformation.model.StackResourceDetail

class StackResourceDetail extends Object implements Serializable

Serialized Fields

description

String description

User defined description associated with the resource.

lastUpdatedTimestamp

Date lastUpdatedTimestamp

Time the status was updated.

logicalResourceId

String logicalResourceId

The logical name of the resource specified in the template.

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.

physicalResourceId

String physicalResourceId

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

resourceStatus

String resourceStatus

Current status of the resource.

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

resourceType

String resourceType

Type of resource. ((For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

stackId

String stackId

Unique identifier of the stack.

stackName

String stackName

The name associated with the stack.

Class com.amazonaws.services.cloudformation.model.StackResourceSummary

class StackResourceSummary extends Object implements Serializable

Serialized Fields

lastUpdatedTimestamp

Date lastUpdatedTimestamp

Time the status was updated.

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.

resourceStatus

String resourceStatus

Current status of the resource.

resourceStatusReason

String resourceStatusReason

Success/failure message associated with the resource.

resourceType

String resourceType

Type of resource. (For more information, go to AWS Resource Types Reference in the AWS CloudFormation User Guide.)

Class com.amazonaws.services.cloudformation.model.StackSummary

class StackSummary extends Object implements Serializable

Serialized Fields

creationTime

Date creationTime

The time the stack was created.

deletionTime

Date deletionTime

The time the stack was deleted.

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.

stackId

String stackId

Unique stack identifier.

stackName

String stackName

The name associated with the stack.

stackStatus

String stackStatus

The current status of the stack.

stackStatusReason

String stackStatusReason

Success/Failure message associated with the stack status.

templateDescription

String templateDescription

The template description of the template used to create the stack.

Class com.amazonaws.services.cloudformation.model.Tag

class 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

class TemplateParameter extends Object implements Serializable

Serialized Fields

defaultValue

String defaultValue

The default value associated with the parameter.

description

String description

User defined description associated with the parameter.

noEcho

Boolean noEcho

Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

parameterKey

String parameterKey

The name associated with the parameter.

Class com.amazonaws.services.cloudformation.model.UpdateStackRequest

class UpdateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

capabilities

com.amazonaws.internal.SdkInternalList<String> 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.

notificationARNs

com.amazonaws.internal.SdkInternalList<String> 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.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of Parameter structures that specify input parameters for the stack. For more information, see the Parameter data type.

resourceTypes

com.amazonaws.internal.SdkInternalList<String> 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.

stackName

String stackName

The name or unique stack ID of the stack to update.

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.

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.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.

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.

Class com.amazonaws.services.cloudformation.model.UpdateStackResult

class UpdateStackResult extends Object implements Serializable

Serialized Fields

stackId

String stackId

Unique identifier of the stack.

Class com.amazonaws.services.cloudformation.model.ValidateTemplateRequest

class 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

class ValidateTemplateResult extends Object implements Serializable

Serialized Fields

capabilities

com.amazonaws.internal.SdkInternalList<String> 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.

description

String description

The description found within the template.

parameters

com.amazonaws.internal.SdkInternalList<TemplateParameter> parameters

A list of TemplateParameter structures.

Package com.amazonaws.services.cloudfront.model

Exception Class com.amazonaws.services.cloudfront.model.AccessDeniedException

class AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.ActiveTrustedSigners

class ActiveTrustedSigners extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Each active trusted signer.

items

com.amazonaws.internal.SdkInternalList<Signer> 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.

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.

Class com.amazonaws.services.cloudfront.model.Aliases

class Aliases extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> items

Optional: A complex type that contains CNAME elements, if any, for this distribution. If Quantity is 0, you can omit Items.

quantity

Integer quantity

The number of CNAMEs, if any, for this distribution.

Class com.amazonaws.services.cloudfront.model.AllowedMethods

class AllowedMethods extends Object implements Serializable

Serialized Fields

cachedMethods

CachedMethods cachedMethods

items

com.amazonaws.internal.SdkInternalList<String> items

A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.

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

Exception Class com.amazonaws.services.cloudfront.model.BatchTooLargeException

class BatchTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.CacheBehavior

class CacheBehavior extends Object implements Serializable

Serialized Fields

allowedMethods

AllowedMethods allowedMethods

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.

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

forwardedValues

ForwardedValues forwardedValues

A complex type that specifies how CloudFront handles query strings, cookies and headers.

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

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

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.

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.

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.

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.

Class com.amazonaws.services.cloudfront.model.CacheBehaviors

class CacheBehaviors extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<CacheBehavior> items

Optional: A complex type that contains cache behaviors for this distribution. If Quantity is 0, you can omit Items.

quantity

Integer quantity

The number of cache behaviors for this distribution.

Class com.amazonaws.services.cloudfront.model.CachedMethods

class CachedMethods extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> items

A complex type that contains the HTTP methods that you want CloudFront to cache responses to.

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

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentity

class CloudFrontOriginAccessIdentity extends Object implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentityConfig

CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

The current configuration information for the identity.

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.

Exception Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityAlreadyExistsException

class CloudFrontOriginAccessIdentityAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityConfig

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

Exception Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityInUseException

class CloudFrontOriginAccessIdentityInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentityList

class CloudFrontOriginAccessIdentityList extends Object implements Serializable

Serialized Fields

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.

items

com.amazonaws.internal.SdkInternalList<CloudFrontOriginAccessIdentitySummary> items

A complex type that contains one CloudFrontOriginAccessIdentitySummary element for each origin access identity that was created by the current AWS account.

marker

String marker

The value you provided for the Marker request parameter.

maxItems

Integer maxItems

The value you provided for the MaxItems 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.

quantity

Integer quantity

The number of CloudFront origin access identities that were created by the current AWS account.

Class com.amazonaws.services.cloudfront.model.CloudFrontOriginAccessIdentitySummary

class CloudFrontOriginAccessIdentitySummary extends Object implements Serializable

Serialized Fields

comment

String comment

The comment for this origin access identity, as originally specified when created.

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.

Exception Class com.amazonaws.services.cloudfront.model.CNAMEAlreadyExistsException

class CNAMEAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.CookieNames

class CookieNames extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> items

Optional: A complex type that contains whitelisted cookies for this cache behavior. If Quantity is 0, you can omit Items.

quantity

Integer quantity

The number of whitelisted cookies for this cache behavior.

Class com.amazonaws.services.cloudfront.model.CookiePreference

class 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

class CreateCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentityConfig

CloudFrontOriginAccessIdentityConfig cloudFrontOriginAccessIdentityConfig

The origin access identity's configuration information.

Class com.amazonaws.services.cloudfront.model.CreateCloudFrontOriginAccessIdentityResult

class CreateCloudFrontOriginAccessIdentityResult 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 created.

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.

Class com.amazonaws.services.cloudfront.model.CreateDistributionRequest

class CreateDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

distributionConfig

DistributionConfig distributionConfig

The distribution's configuration information.

Class com.amazonaws.services.cloudfront.model.CreateDistributionResult

class CreateDistributionResult extends Object implements Serializable

Serialized Fields

distribution

Distribution distribution

The distribution's information.

eTag

String eTag

The current version of the distribution created.

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.

Class com.amazonaws.services.cloudfront.model.CreateInvalidationRequest

class 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

class CreateInvalidationResult extends Object implements Serializable

Serialized Fields

invalidation

Invalidation invalidation

The invalidation's information.

location

String location

The fully qualified URI of the distribution and invalidation batch request, including the Invalidation ID.

Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionRequest

class CreateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The streaming distribution's configuration information.

Class com.amazonaws.services.cloudfront.model.CreateStreamingDistributionResult

class CreateStreamingDistributionResult extends Object implements Serializable

Serialized Fields

eTag

String eTag

The current version of the streaming distribution created.

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.

streamingDistribution

StreamingDistribution streamingDistribution

The streaming distribution's information.

Class com.amazonaws.services.cloudfront.model.CustomErrorResponse

class CustomErrorResponse extends Object implements Serializable

Serialized Fields

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.

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.

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.

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.

Class com.amazonaws.services.cloudfront.model.CustomErrorResponses

class CustomErrorResponses extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<CustomErrorResponse> items

Optional: A complex type that contains custom error responses for this distribution. If Quantity is 0, you can omit Items.

quantity

Integer quantity

The number of custom error responses for this distribution.

Class com.amazonaws.services.cloudfront.model.CustomHeaders

class CustomHeaders extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<OriginCustomHeader> items

A complex type that contains the custom headers for this Origin.

quantity

Integer quantity

The number of custom headers for this origin.

Class com.amazonaws.services.cloudfront.model.CustomOriginConfig

class 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

class DefaultCacheBehavior extends Object implements Serializable

Serialized Fields

allowedMethods

AllowedMethods allowedMethods

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.

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

forwardedValues

ForwardedValues forwardedValues

A complex type that specifies how CloudFront handles query strings, cookies and headers.

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

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

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.

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.

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.

Class com.amazonaws.services.cloudfront.model.DeleteCloudFrontOriginAccessIdentityRequest

class 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.DeleteCloudFrontOriginAccessIdentityResult

class DeleteCloudFrontOriginAccessIdentityResult extends Object implements Serializable

Class com.amazonaws.services.cloudfront.model.DeleteDistributionRequest

class 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.DeleteDistributionResult

class DeleteDistributionResult extends Object implements Serializable

Class com.amazonaws.services.cloudfront.model.DeleteStreamingDistributionRequest

class 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.DeleteStreamingDistributionResult

class DeleteStreamingDistributionResult extends Object implements Serializable

Class com.amazonaws.services.cloudfront.model.Distribution

class Distribution extends Object implements Serializable

Serialized Fields

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.

domainName

String domainName

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

id

String id

The identifier for the distribution. For example: EDFDVBD632BHDS5.

inProgressInvalidationBatches

Integer inProgressInvalidationBatches

The number of invalidation batches currently in progress.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

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.

Exception Class com.amazonaws.services.cloudfront.model.DistributionAlreadyExistsException

class DistributionAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.DistributionConfig

class DistributionConfig extends Object implements Serializable

Serialized Fields

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

cacheBehaviors

CacheBehaviors cacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

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.

comment

String comment

Any comments you want to include about the distribution.

customErrorResponses

CustomErrorResponses customErrorResponses

A complex type that contains zero or more CustomErrorResponse elements.

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.

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.

enabled

Boolean enabled

Whether the distribution is enabled to accept end user requests for content.

logging

LoggingConfig logging

A complex type that controls whether access logs are written for the distribution.

origins

Origins origins

A complex type that contains information about origins for this distribution.

priceClass

String priceClass

A complex type that contains information about price class for this distribution.

restrictions

Restrictions restrictions

viewerCertificate

ViewerCertificate viewerCertificate

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

class DistributionList extends Object implements Serializable

Serialized Fields

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.

items

com.amazonaws.internal.SdkInternalList<DistributionSummary> items

A complex type that contains one DistributionSummary element for each distribution that was created by the current AWS account.

marker

String marker

The value you provided for the Marker request parameter.

maxItems

Integer maxItems

The value you provided for the MaxItems 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.

quantity

Integer quantity

The number of distributions that were created by the current AWS account.

Exception Class com.amazonaws.services.cloudfront.model.DistributionNotDisabledException

class DistributionNotDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.DistributionSummary

class DistributionSummary extends Object implements Serializable

Serialized Fields

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.

cacheBehaviors

CacheBehaviors cacheBehaviors

A complex type that contains zero or more CacheBehavior elements.

comment

String comment

The comment originally specified when this distribution was created.

customErrorResponses

CustomErrorResponses customErrorResponses

A complex type that contains zero or more CustomErrorResponses elements.

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.

domainName

String domainName

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

enabled

Boolean enabled

Whether the distribution is enabled to accept end user requests for content.

id

String id

The identifier for the distribution. For example: EDFDVBD632BHDS5.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

origins

Origins origins

A complex type that contains information about origins for this distribution.

priceClass

String priceClass

restrictions

Restrictions restrictions

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.

viewerCertificate

ViewerCertificate viewerCertificate

webACLId

String webACLId

The Web ACL Id (if any) associated with the distribution.

Class com.amazonaws.services.cloudfront.model.ForwardedValues

class ForwardedValues extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.cloudfront.model.GeoRestriction

class GeoRestriction extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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.

Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigRequest

class GetCloudFrontOriginAccessIdentityConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identity's id.

Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityConfigResult

class 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

class GetCloudFrontOriginAccessIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identity's id.

Class com.amazonaws.services.cloudfront.model.GetCloudFrontOriginAccessIdentityResult

class 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

class GetDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The distribution's id.

Class com.amazonaws.services.cloudfront.model.GetDistributionConfigResult

class 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

class GetDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The distribution's id.

Class com.amazonaws.services.cloudfront.model.GetDistributionResult

class 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

class 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

class GetInvalidationResult extends Object implements Serializable

Serialized Fields

invalidation

Invalidation invalidation

The invalidation's information.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigRequest

class GetStreamingDistributionConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The streaming distribution's id.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionConfigResult

class GetStreamingDistributionConfigResult extends Object implements Serializable

Serialized Fields

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The streaming distribution's configuration information.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionRequest

class GetStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The streaming distribution's id.

Class com.amazonaws.services.cloudfront.model.GetStreamingDistributionResult

class GetStreamingDistributionResult extends Object implements Serializable

Serialized Fields

eTag

String eTag

The current version of the streaming distribution's information. For example: E2QWRUHAPOMQZL.

streamingDistribution

StreamingDistribution streamingDistribution

The streaming distribution's information.

Class com.amazonaws.services.cloudfront.model.Headers

class Headers extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> 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.

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.

Exception Class com.amazonaws.services.cloudfront.model.IllegalUpdateException

class IllegalUpdateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InconsistentQuantitiesException

class InconsistentQuantitiesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidArgumentException

class InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.Invalidation

class Invalidation extends Object implements Serializable

Serialized Fields

createTime

Date createTime

The date and time the invalidation request was first made.

id

String id

The identifier for the invalidation request. For example: IDFDVBD632BHDS5.

invalidationBatch

InvalidationBatch invalidationBatch

The current invalidation information for the batch request.

status

String status

The status of the invalidation request. When the invalidation batch is finished, the status is Completed.

Class com.amazonaws.services.cloudfront.model.InvalidationBatch

class InvalidationBatch extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.cloudfront.model.InvalidationList

class InvalidationList extends Object implements Serializable

Serialized Fields

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.

items

com.amazonaws.internal.SdkInternalList<InvalidationSummary> items

A complex type that contains one InvalidationSummary element for each invalidation batch that was created by the current AWS account.

marker

String marker

The value you provided for the Marker request parameter.

maxItems

Integer maxItems

The value you provided for the MaxItems 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.

quantity

Integer quantity

The number of invalidation batches that were created by the current AWS account.

Class com.amazonaws.services.cloudfront.model.InvalidationSummary

class InvalidationSummary extends Object implements Serializable

Serialized Fields

createTime

Date createTime

id

String id

The unique ID for an invalidation request.

status

String status

The status of an invalidation request.

Exception Class com.amazonaws.services.cloudfront.model.InvalidDefaultRootObjectException

class InvalidDefaultRootObjectException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidErrorCodeException

class InvalidErrorCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidForwardCookiesException

class InvalidForwardCookiesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidGeoRestrictionParameterException

class InvalidGeoRestrictionParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidHeadersForS3OriginException

class InvalidHeadersForS3OriginException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidIfMatchVersionException

class InvalidIfMatchVersionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidLocationCodeException

class InvalidLocationCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidMinimumProtocolVersionException

class InvalidMinimumProtocolVersionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidOriginAccessIdentityException

class InvalidOriginAccessIdentityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidOriginException

class InvalidOriginException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidProtocolSettingsException

class InvalidProtocolSettingsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidRelativePathException

class InvalidRelativePathException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidRequiredProtocolException

class InvalidRequiredProtocolException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidResponseCodeException

class InvalidResponseCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidTTLOrderException

class InvalidTTLOrderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidViewerCertificateException

class InvalidViewerCertificateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.InvalidWebACLIdException

class InvalidWebACLIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.KeyPairIds

class KeyPairIds extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> items

A complex type that lists the active CloudFront key pairs, if any, that are associated with AwsAccountNumber.

quantity

Integer quantity

The number of active CloudFront key pairs for AwsAccountNumber.

Class com.amazonaws.services.cloudfront.model.ListCloudFrontOriginAccessIdentitiesRequest

class 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

class ListCloudFrontOriginAccessIdentitiesResult extends Object implements Serializable

Serialized Fields

cloudFrontOriginAccessIdentityList

CloudFrontOriginAccessIdentityList cloudFrontOriginAccessIdentityList

The CloudFrontOriginAccessIdentityList type.

Class com.amazonaws.services.cloudfront.model.ListDistributionsByWebACLIdRequest

class 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

class ListDistributionsByWebACLIdResult extends Object implements Serializable

Serialized Fields

distributionList

DistributionList distributionList

The DistributionList type.

Class com.amazonaws.services.cloudfront.model.ListDistributionsRequest

class 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

class ListDistributionsResult extends Object implements Serializable

Serialized Fields

distributionList

DistributionList distributionList

The DistributionList type.

Class com.amazonaws.services.cloudfront.model.ListInvalidationsRequest

class 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

class ListInvalidationsResult extends Object implements Serializable

Serialized Fields

invalidationList

InvalidationList invalidationList

Information about invalidation batches.

Class com.amazonaws.services.cloudfront.model.ListStreamingDistributionsRequest

class 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

class ListStreamingDistributionsResult extends Object implements Serializable

Serialized Fields

streamingDistributionList

StreamingDistributionList streamingDistributionList

The StreamingDistributionList type.

Class com.amazonaws.services.cloudfront.model.LoggingConfig

class LoggingConfig extends Object implements Serializable

Serialized Fields

bucket

String bucket

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

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.

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.

Exception Class com.amazonaws.services.cloudfront.model.MissingBodyException

class MissingBodyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.NoSuchCloudFrontOriginAccessIdentityException

class NoSuchCloudFrontOriginAccessIdentityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.NoSuchDistributionException

class NoSuchDistributionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.NoSuchInvalidationException

class NoSuchInvalidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.NoSuchOriginException

class NoSuchOriginException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.NoSuchStreamingDistributionException

class NoSuchStreamingDistributionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.Origin

class Origin extends Object implements Serializable

Serialized Fields

customHeaders

CustomHeaders customHeaders

A complex type that contains information about the custom headers associated with this Origin.

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.

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.

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.

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.

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.

Class com.amazonaws.services.cloudfront.model.OriginCustomHeader

class 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

class Origins extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<Origin> items

A complex type that contains origins for this distribution.

quantity

Integer quantity

The number of origins for this distribution.

Class com.amazonaws.services.cloudfront.model.OriginSslProtocols

class OriginSslProtocols extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> 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.

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.

Class com.amazonaws.services.cloudfront.model.Paths

class Paths extends Object implements Serializable

Serialized Fields

items

com.amazonaws.internal.SdkInternalList<String> items

A complex type that contains a list of the objects that you want to invalidate.

quantity

Integer quantity

The number of objects that you want to invalidate.

Exception Class com.amazonaws.services.cloudfront.model.PreconditionFailedException

class PreconditionFailedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.Restrictions

class Restrictions extends Object implements Serializable

Serialized Fields

geoRestriction

GeoRestriction geoRestriction

Class com.amazonaws.services.cloudfront.model.S3Origin

class 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

class 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

class 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

class StreamingDistribution extends Object implements Serializable

Serialized Fields

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.

domainName

String domainName

The domain name corresponding to the streaming distribution. For example: s5c39gqb8ow64r.cloudfront.net.

id

String id

The identifier for the streaming distribution. For example: EGTXBD79H29TRA8.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

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.

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The current configuration information for the streaming distribution.

Exception Class com.amazonaws.services.cloudfront.model.StreamingDistributionAlreadyExistsException

class StreamingDistributionAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.StreamingDistributionConfig

class StreamingDistributionConfig extends Object implements Serializable

Serialized Fields

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

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.

comment

String comment

Any comments you want to include about the streaming distribution.

enabled

Boolean enabled

Whether the streaming distribution is enabled to accept end user requests for content.

logging

StreamingLoggingConfig logging

A complex type that controls whether access logs are written for the streaming distribution.

priceClass

String priceClass

A complex type that contains information about price class for this streaming distribution.

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.

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.

Class com.amazonaws.services.cloudfront.model.StreamingDistributionList

class StreamingDistributionList extends Object implements Serializable

Serialized Fields

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.

items

com.amazonaws.internal.SdkInternalList<StreamingDistributionSummary> items

A complex type that contains one StreamingDistributionSummary element for each distribution that was created by the current AWS account.

marker

String marker

The value you provided for the Marker request parameter.

maxItems

Integer maxItems

The value you provided for the MaxItems 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.

quantity

Integer quantity

The number of streaming distributions that were created by the current AWS account.

Exception Class com.amazonaws.services.cloudfront.model.StreamingDistributionNotDisabledException

class StreamingDistributionNotDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.StreamingDistributionSummary

class StreamingDistributionSummary extends Object implements Serializable

Serialized Fields

aliases

Aliases aliases

A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.

comment

String comment

The comment originally specified when this distribution was created.

domainName

String domainName

The domain name corresponding to the distribution. For example: d604721fxaaqy9.cloudfront.net.

enabled

Boolean enabled

Whether the distribution is enabled to accept end user requests for content.

id

String id

The identifier for the distribution. For example: EDFDVBD632BHDS5.

lastModifiedTime

Date lastModifiedTime

The date and time the distribution was last modified.

priceClass

String priceClass

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.

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.

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.

Class com.amazonaws.services.cloudfront.model.StreamingLoggingConfig

class StreamingLoggingConfig extends Object implements Serializable

Serialized Fields

bucket

String bucket

The Amazon S3 bucket to store the access logs in, for example, myawslogbucket.s3.amazonaws.com.

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.

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.

Exception Class com.amazonaws.services.cloudfront.model.TooManyCacheBehaviorsException

class TooManyCacheBehaviorsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyCertificatesException

class TooManyCertificatesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyCloudFrontOriginAccessIdentitiesException

class TooManyCloudFrontOriginAccessIdentitiesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyCookieNamesInWhiteListException

class TooManyCookieNamesInWhiteListException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyDistributionCNAMEsException

class TooManyDistributionCNAMEsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyDistributionsException

class TooManyDistributionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyHeadersInForwardedValuesException

class TooManyHeadersInForwardedValuesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyInvalidationsInProgressException

class TooManyInvalidationsInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyOriginCustomHeadersException

class TooManyOriginCustomHeadersException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyOriginsException

class TooManyOriginsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionCNAMEsException

class TooManyStreamingDistributionCNAMEsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyStreamingDistributionsException

class TooManyStreamingDistributionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TooManyTrustedSignersException

class TooManyTrustedSignersException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudfront.model.TrustedSignerDoesNotExistException

class TrustedSignerDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudfront.model.TrustedSigners

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

items

com.amazonaws.internal.SdkInternalList<String> items

Optional: A complex type that contains trusted signers for this cache behavior. If Quantity is 0, you can omit Items.

quantity

Integer quantity

The number of trusted signers for this cache behavior.

Class com.amazonaws.services.cloudfront.model.UpdateCloudFrontOriginAccessIdentityRequest

class 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

class 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

class 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

class 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

class UpdateStreamingDistributionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

streamingDistributionConfig

StreamingDistributionConfig streamingDistributionConfig

The streaming distribution's configuration information.

Class com.amazonaws.services.cloudfront.model.UpdateStreamingDistributionResult

class UpdateStreamingDistributionResult extends Object implements Serializable

Serialized Fields

eTag

String eTag

The current version of the configuration. For example: E2QWRUHAPOMQZL.

streamingDistribution

StreamingDistribution streamingDistribution

The streaming distribution's information.

Class com.amazonaws.services.cloudfront.model.ViewerCertificate

class ViewerCertificate extends Object implements Serializable

Serialized Fields

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.

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

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.

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.

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.

Package com.amazonaws.services.cloudhsm.model

Class com.amazonaws.services.cloudhsm.model.AddTagsToResourceRequest

class AddTagsToResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

String resourceArn

The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.

tagList

com.amazonaws.internal.SdkInternalList<Tag> tagList

One or more tags.

Class com.amazonaws.services.cloudhsm.model.AddTagsToResourceResult

class AddTagsToResourceResult extends Object implements Serializable

Serialized Fields

status

String status

The status of the operation.

Exception Class com.amazonaws.services.cloudhsm.model.CloudHsmInternalException

class CloudHsmInternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudhsm.model.CloudHsmServiceException

class CloudHsmServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudhsm.model.CreateHapgRequest

class 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

class 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

class CreateHsmRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

String clientToken

A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.

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.

externalId

String externalId

The external ID from IamRoleArn, if present.

iamRoleArn

String iamRoleArn

The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.

sshKey

String sshKey

The SSH public key to install on the HSM.

subnetId

String subnetId

The identifier of the subnet in your VPC in which to place the HSM.

subscriptionType

String subscriptionType

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

class CreateHsmResult extends Object implements Serializable

Serialized Fields

hsmArn

String hsmArn

The ARN of the HSM.

Class com.amazonaws.services.cloudhsm.model.CreateLunaClientRequest

class CreateLunaClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificate

String certificate

The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.

label

String label

The label for the client.

Class com.amazonaws.services.cloudhsm.model.CreateLunaClientResult

class CreateLunaClientResult extends Object implements Serializable

Serialized Fields

clientArn

String clientArn

The ARN of the client.

Class com.amazonaws.services.cloudhsm.model.DeleteHapgRequest

class 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

class DeleteHapgResult extends Object implements Serializable

Serialized Fields

status

String status

The status of the action.

Class com.amazonaws.services.cloudhsm.model.DeleteHsmRequest

class DeleteHsmRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hsmArn

String hsmArn

The ARN of the HSM to delete.

Class com.amazonaws.services.cloudhsm.model.DeleteHsmResult

class DeleteHsmResult extends Object implements Serializable

Serialized Fields

status

String status

The status of the operation.

Class com.amazonaws.services.cloudhsm.model.DeleteLunaClientRequest

class DeleteLunaClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientArn

String clientArn

The ARN of the client to delete.

Class com.amazonaws.services.cloudhsm.model.DeleteLunaClientResult

class DeleteLunaClientResult extends Object implements Serializable

Serialized Fields

status

String status

The status of the action.

Class com.amazonaws.services.cloudhsm.model.DescribeHapgRequest

class 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

class 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<String> hsmsLastActionFailed

hsmsPendingDeletion

com.amazonaws.internal.SdkInternalList<String> hsmsPendingDeletion

hsmsPendingRegistration

com.amazonaws.internal.SdkInternalList<String> 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<String> 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

class 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

class DescribeHsmResult extends Object implements Serializable

Serialized Fields

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.

hsmArn

String hsmArn

The ARN of the HSM.

hsmType

String hsmType

The HSM model type.

iamRoleArn

String iamRoleArn

The ARN of the IAM role assigned to the HSM.

partitions

com.amazonaws.internal.SdkInternalList<String> partitions

The list of partitions on the HSM.

serialNumber

String serialNumber

The serial number of the HSM.

serverCertLastUpdated

String serverCertLastUpdated

The date and time that the server certificate was last updated.

serverCertUri

String serverCertUri

The URI of the certificate server.

softwareVersion

String softwareVersion

The HSM software version.

sshKeyLastUpdated

String sshKeyLastUpdated

The date and time that the SSH key was last updated.

sshPublicKey

String sshPublicKey

The public SSH key.

status

String status

The status of the HSM.

statusDetails

String statusDetails

Contains additional information about the status of the HSM.

subnetId

String subnetId

The identifier of the subnet that the HSM is in.

subscriptionEndDate

String subscriptionEndDate

The subscription end date.

subscriptionStartDate

String subscriptionStartDate

The subscription start date.

subscriptionType

String subscriptionType

vendorName

String vendorName

The name of the HSM vendor.

vpcId

String vpcId

The identifier of the VPC that the HSM is in.

Class com.amazonaws.services.cloudhsm.model.DescribeLunaClientRequest

class DescribeLunaClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateFingerprint

String certificateFingerprint

The certificate fingerprint.

clientArn

String clientArn

The ARN of the client.

Class com.amazonaws.services.cloudhsm.model.DescribeLunaClientResult

class DescribeLunaClientResult extends Object implements Serializable

Serialized Fields

certificate

String certificate

The certificate installed on the HSMs used by this client.

certificateFingerprint

String certificateFingerprint

The certificate fingerprint.

clientArn

String clientArn

The ARN of the client.

label

String label

The label of the client.

lastModifiedTimestamp

String lastModifiedTimestamp

The date and time the client was last modified.

Class com.amazonaws.services.cloudhsm.model.GetConfigRequest

class 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<String> 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

class GetConfigResult extends Object implements Serializable

Serialized Fields

configCred

String configCred

The certificate file containing the server.pem files of the HSMs.

configFile

String configFile

The chrystoki.conf configuration file.

configType

String configType

The type of credentials.

Exception Class com.amazonaws.services.cloudhsm.model.InvalidRequestException

class InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudhsm.model.ListAvailableZonesRequest

class ListAvailableZonesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.cloudhsm.model.ListAvailableZonesResult

class ListAvailableZonesResult extends Object implements Serializable

Serialized Fields

aZList

com.amazonaws.internal.SdkInternalList<String> aZList

The list of Availability Zones that have available AWS CloudHSM capacity.

Class com.amazonaws.services.cloudhsm.model.ListHapgsRequest

class 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

class ListHapgsResult extends Object implements Serializable

Serialized Fields

hapgList

com.amazonaws.internal.SdkInternalList<String> 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

class 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

class ListHsmsResult extends Object implements Serializable

Serialized Fields

hsmList

com.amazonaws.internal.SdkInternalList<String> 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

class 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

class ListLunaClientsResult extends Object implements Serializable

Serialized Fields

clientList

com.amazonaws.internal.SdkInternalList<String> 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

class ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

String resourceArn

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

Class com.amazonaws.services.cloudhsm.model.ListTagsForResourceResult

class ListTagsForResourceResult extends Object implements Serializable

Serialized Fields

tagList

com.amazonaws.internal.SdkInternalList<Tag> tagList

One or more tags.

Class com.amazonaws.services.cloudhsm.model.ModifyHapgRequest

class 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<String> partitionSerialList

The list of partition serial numbers to make members of the high-availability partition group.

Class com.amazonaws.services.cloudhsm.model.ModifyHapgResult

class 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

class ModifyHsmRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

externalId

String externalId

The new external ID.

hsmArn

String hsmArn

The ARN of the HSM to modify.

iamRoleArn

String iamRoleArn

The new IAM role ARN.

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.

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

class ModifyHsmResult extends Object implements Serializable

Serialized Fields

hsmArn

String hsmArn

The ARN of the HSM.

Class com.amazonaws.services.cloudhsm.model.ModifyLunaClientRequest

class ModifyLunaClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificate

String certificate

The new certificate for the client.

clientArn

String clientArn

The ARN of the client.

Class com.amazonaws.services.cloudhsm.model.ModifyLunaClientResult

class ModifyLunaClientResult extends Object implements Serializable

Serialized Fields

clientArn

String clientArn

The ARN of the client.

Class com.amazonaws.services.cloudhsm.model.RemoveTagsFromResourceRequest

class RemoveTagsFromResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

String resourceArn

The Amazon Resource Name (ARN) of the AWS CloudHSM resource.

tagKeyList

com.amazonaws.internal.SdkInternalList<String> 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

class RemoveTagsFromResourceResult extends Object implements Serializable

Serialized Fields

status

String status

The status of the operation.

Class com.amazonaws.services.cloudhsm.model.Tag

class 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.cloudsearchdomain.model

Class com.amazonaws.services.cloudsearchdomain.model.Bucket

class Bucket extends Object implements Serializable

Serialized Fields

count

Long count

The number of hits that contain the facet value in the specified facet field.

value

String value

The facet value being counted.

Class com.amazonaws.services.cloudsearchdomain.model.BucketInfo

class BucketInfo extends Object implements Serializable

Serialized Fields

buckets

com.amazonaws.internal.SdkInternalList<Bucket> buckets

A list of the calculated facet values and counts.

Exception Class com.amazonaws.services.cloudsearchdomain.model.DocumentServiceException

class 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

class 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

class FieldStats extends Object implements Serializable

Serialized Fields

count

Long count

The number of documents that contain a value in the specified field in the result set.

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.

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.

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.

missing

Long missing

The number of documents that do not contain a value in the specified field in the result set.

stddev

Double stddev

The standard deviation of the values 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.

Class com.amazonaws.services.cloudsearchdomain.model.Hit

class Hit extends Object implements Serializable

Serialized Fields

exprs

com.amazonaws.internal.SdkInternalMap<String,String> exprs

The expressions returned from a document that matches the search request.

fields

com.amazonaws.internal.SdkInternalMap<String, List<String>> fields

The fields returned from a document that matches the search request.

highlights

com.amazonaws.internal.SdkInternalMap<String,String> highlights

The highlights returned from a document that matches the search request.

id

String id

The document ID of a document that matches the search request.

Class com.amazonaws.services.cloudsearchdomain.model.Hits

class Hits extends Object implements Serializable

Serialized Fields

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.

found

Long found

The total number of documents that match the search request.

hit

com.amazonaws.internal.SdkInternalList<Hit> hit

A document that matches the search request.

start

Long start

The index of the first matching document.

Exception Class com.amazonaws.services.cloudsearchdomain.model.SearchException

class SearchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudsearchdomain.model.SearchRequest

class 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

class SearchResult extends Object implements Serializable

Serialized Fields

facets

com.amazonaws.internal.SdkInternalMap<String, BucketInfo> facets

The requested facet information.

hits

Hits hits

The documents that match the search criteria.

stats

com.amazonaws.internal.SdkInternalMap<String, FieldStats> stats

The requested field statistics information.

status

SearchStatus status

The status information returned for the search request.

Class com.amazonaws.services.cloudsearchdomain.model.SearchStatus

class SearchStatus extends Object implements Serializable

Serialized Fields

rid

String rid

The encrypted resource ID for the request.

timems

Long timems

How long it took to process the request, in milliseconds.

Class com.amazonaws.services.cloudsearchdomain.model.SuggestionMatch

class SuggestionMatch extends Object implements Serializable

Serialized Fields

id

String id

The document ID of the suggested document.

score

Long score

The relevance score of a suggested match.

suggestion

String suggestion

The string that matches the query string specified in the SuggestRequest.

Class com.amazonaws.services.cloudsearchdomain.model.SuggestModel

class SuggestModel extends Object implements Serializable

Serialized Fields

found

Long found

The number of documents that were found to match the query string.

query

String query

The query string specified in the suggest request.

suggestions

com.amazonaws.internal.SdkInternalList<SuggestionMatch> suggestions

The documents that match the query string.

Class com.amazonaws.services.cloudsearchdomain.model.SuggestRequest

class SuggestRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

query

String query

Specifies the string for which you want to get suggestions.

size

Long size

Specifies the maximum number of suggestions to return.

suggester

String suggester

Specifies the name of the suggester to use to find suggested matches.

Class com.amazonaws.services.cloudsearchdomain.model.SuggestResult

class 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

class SuggestStatus extends Object implements Serializable

Serialized Fields

rid

String rid

The encrypted resource ID for the request.

timems

Long timems

How long it took to process the request, in milliseconds.

Class com.amazonaws.services.cloudsearchdomain.model.UploadDocumentsRequest

class UploadDocumentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contentLength

Long contentLength

contentType

String contentType

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

• application/json
• application/xml

documents

InputStream documents

A batch of documents formatted in JSON or HTML.

Class com.amazonaws.services.cloudsearchdomain.model.UploadDocumentsResult

class UploadDocumentsResult extends Object implements Serializable

Serialized Fields

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.

status

String status

The status of an UploadDocumentsRequest.

warnings

com.amazonaws.internal.SdkInternalList<DocumentServiceWarning> 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

class AccessPoliciesStatus extends Object implements Serializable

Serialized Fields

options

String options

status

OptionStatus status

Class com.amazonaws.services.cloudsearchv2.model.AnalysisOptions

class AnalysisOptions extends Object implements Serializable

Serialized 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

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.

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.

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.

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.

Class com.amazonaws.services.cloudsearchv2.model.AnalysisScheme

class AnalysisScheme extends Object implements Serializable

Serialized Fields

analysisOptions

AnalysisOptions analysisOptions

analysisSchemeLanguage

String analysisSchemeLanguage

analysisSchemeName

String analysisSchemeName

Class com.amazonaws.services.cloudsearchv2.model.AnalysisSchemeStatus

class AnalysisSchemeStatus extends Object implements Serializable

Serialized Fields

options

AnalysisScheme options

status

OptionStatus status

Class com.amazonaws.services.cloudsearchv2.model.AvailabilityOptionsStatus

class AvailabilityOptionsStatus extends Object implements Serializable

Serialized Fields

options

Boolean options

The availability options configured for the domain.

status

OptionStatus status

Exception Class com.amazonaws.services.cloudsearchv2.model.BaseException

class BaseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

Class com.amazonaws.services.cloudsearchv2.model.BuildSuggestersRequest

class BuildSuggestersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

Class com.amazonaws.services.cloudsearchv2.model.BuildSuggestersResult

class BuildSuggestersResult extends Object implements Serializable

Serialized Fields

fieldNames

com.amazonaws.internal.SdkInternalList<String> fieldNames

Class com.amazonaws.services.cloudsearchv2.model.CreateDomainRequest

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

Class com.amazonaws.services.cloudsearchv2.model.CreateDomainResult

class CreateDomainResult extends Object implements Serializable

Serialized Fields

domainStatus

DomainStatus domainStatus

Class com.amazonaws.services.cloudsearchv2.model.DateArrayOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sourceFields

String sourceFields

A list of source fields to map to the field.

Class com.amazonaws.services.cloudsearchv2.model.DateOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sortEnabled

Boolean sortEnabled

Whether the field can be used to sort the search results.

sourceField

String sourceField

Class com.amazonaws.services.cloudsearchv2.model.DefineAnalysisSchemeRequest

class DefineAnalysisSchemeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analysisScheme

AnalysisScheme analysisScheme

domainName

String domainName

Class com.amazonaws.services.cloudsearchv2.model.DefineAnalysisSchemeResult

class DefineAnalysisSchemeResult extends Object implements Serializable

Serialized Fields

analysisScheme

AnalysisSchemeStatus analysisScheme

Class com.amazonaws.services.cloudsearchv2.model.DefineExpressionRequest

class DefineExpressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

expression

Expression expression

Class com.amazonaws.services.cloudsearchv2.model.DefineExpressionResult

class DefineExpressionResult extends Object implements Serializable

Serialized Fields

expression

ExpressionStatus expression

Class com.amazonaws.services.cloudsearchv2.model.DefineIndexFieldRequest

class DefineIndexFieldRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

indexField

IndexField indexField

The index field and field options you want to configure.

Class com.amazonaws.services.cloudsearchv2.model.DefineIndexFieldResult

class DefineIndexFieldResult extends Object implements Serializable

Serialized Fields

indexField

IndexFieldStatus indexField

Class com.amazonaws.services.cloudsearchv2.model.DefineSuggesterRequest

class DefineSuggesterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

suggester

Suggester suggester

Class com.amazonaws.services.cloudsearchv2.model.DefineSuggesterResult

class DefineSuggesterResult extends Object implements Serializable

Serialized Fields

suggester

SuggesterStatus suggester

Class com.amazonaws.services.cloudsearchv2.model.DeleteAnalysisSchemeRequest

class DeleteAnalysisSchemeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analysisSchemeName

String analysisSchemeName

The name of the analysis scheme you want to delete.

domainName

String domainName

Class com.amazonaws.services.cloudsearchv2.model.DeleteAnalysisSchemeResult

class 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

class DeleteDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

The name of the domain you want to permanently delete.

Class com.amazonaws.services.cloudsearchv2.model.DeleteDomainResult

class DeleteDomainResult extends Object implements Serializable

Serialized Fields

domainStatus

DomainStatus domainStatus

Class com.amazonaws.services.cloudsearchv2.model.DeleteExpressionRequest

class DeleteExpressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

expressionName

String expressionName

The name of the Expression to delete.

Class com.amazonaws.services.cloudsearchv2.model.DeleteExpressionResult

class DeleteExpressionResult extends Object implements Serializable

Serialized Fields

expression

ExpressionStatus expression

The status of the expression being deleted.

Class com.amazonaws.services.cloudsearchv2.model.DeleteIndexFieldRequest

class DeleteIndexFieldRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

indexFieldName

String indexFieldName

The name of the index field your want to remove from the domain's indexing options.

Class com.amazonaws.services.cloudsearchv2.model.DeleteIndexFieldResult

class 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

class DeleteSuggesterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

suggesterName

String suggesterName

Specifies the name of the suggester you want to delete.

Class com.amazonaws.services.cloudsearchv2.model.DeleteSuggesterResult

class DeleteSuggesterResult extends Object implements Serializable

Serialized Fields

suggester

SuggesterStatus suggester

The status of the suggester being deleted.

Class com.amazonaws.services.cloudsearchv2.model.DescribeAnalysisSchemesRequest

class DescribeAnalysisSchemesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

analysisSchemeNames

com.amazonaws.internal.SdkInternalList<String> 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.

domainName

String domainName

The name of the domain you want to describe.

Class com.amazonaws.services.cloudsearchv2.model.DescribeAnalysisSchemesResult

class DescribeAnalysisSchemesResult extends Object implements Serializable

Serialized Fields

analysisSchemes

com.amazonaws.internal.SdkInternalList<AnalysisSchemeStatus> analysisSchemes

The analysis scheme descriptions.

Class com.amazonaws.services.cloudsearchv2.model.DescribeAvailabilityOptionsRequest

class DescribeAvailabilityOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deployed

Boolean deployed

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

domainName

String domainName

The name of the domain you want to describe.

Class com.amazonaws.services.cloudsearchv2.model.DescribeAvailabilityOptionsResult

class 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

class DescribeDomainsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainNames

com.amazonaws.internal.SdkInternalList<String> domainNames

The names of the domains you want to include in the response.

Class com.amazonaws.services.cloudsearchv2.model.DescribeDomainsResult

class DescribeDomainsResult extends Object implements Serializable

Serialized Fields

domainStatusList

com.amazonaws.internal.SdkInternalList<DomainStatus> domainStatusList

Class com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsRequest

class DescribeExpressionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deployed

Boolean deployed

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

domainName

String domainName

The name of the domain you want to describe.

expressionNames

com.amazonaws.internal.SdkInternalList<String> expressionNames

Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

Class com.amazonaws.services.cloudsearchv2.model.DescribeExpressionsResult

class DescribeExpressionsResult extends Object implements Serializable

Serialized Fields

expressions

com.amazonaws.internal.SdkInternalList<ExpressionStatus> expressions

The expressions configured for the domain.

Class com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsRequest

class DescribeIndexFieldsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deployed

Boolean deployed

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

domainName

String domainName

The name of the domain you want to describe.

fieldNames

com.amazonaws.internal.SdkInternalList<String> fieldNames

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

Class com.amazonaws.services.cloudsearchv2.model.DescribeIndexFieldsResult

class DescribeIndexFieldsResult extends Object implements Serializable

Serialized Fields

indexFields

com.amazonaws.internal.SdkInternalList<IndexFieldStatus> indexFields

The index fields configured for the domain.

Class com.amazonaws.services.cloudsearchv2.model.DescribeScalingParametersRequest

class DescribeScalingParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

Class com.amazonaws.services.cloudsearchv2.model.DescribeScalingParametersResult

class DescribeScalingParametersResult extends Object implements Serializable

Serialized Fields

scalingParameters

ScalingParametersStatus scalingParameters

Class com.amazonaws.services.cloudsearchv2.model.DescribeServiceAccessPoliciesRequest

class DescribeServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deployed

Boolean deployed

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

domainName

String domainName

The name of the domain you want to describe.

Class com.amazonaws.services.cloudsearchv2.model.DescribeServiceAccessPoliciesResult

class 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

class DescribeSuggestersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deployed

Boolean deployed

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

domainName

String domainName

The name of the domain you want to describe.

suggesterNames

com.amazonaws.internal.SdkInternalList<String> suggesterNames

The suggesters you want to describe.

Class com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersResult

class DescribeSuggestersResult extends Object implements Serializable

Serialized Fields

suggesters

com.amazonaws.internal.SdkInternalList<SuggesterStatus> suggesters

The suggesters configured for the domain specified in the request.

Exception Class com.amazonaws.services.cloudsearchv2.model.DisabledOperationException

class DisabledOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudsearchv2.model.DocumentSuggesterOptions

class DocumentSuggesterOptions extends Object implements Serializable

Serialized Fields

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.

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.

sourceField

String sourceField

The name of the index field you want to use for suggestions.

Class com.amazonaws.services.cloudsearchv2.model.DomainStatus

class DomainStatus extends Object implements Serializable

Serialized Fields

aRN

String aRN

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.

domainId

String domainId

domainName

String domainName

limits

Limits limits

processing

Boolean processing

True if processing is being done to activate the current domain configuration.

requiresIndexDocuments

Boolean requiresIndexDocuments

True if IndexDocuments needs to be called to activate the current domain configuration.

searchInstanceCount

Integer searchInstanceCount

The number of search instances that are available to process search requests.

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.

searchService

ServiceEndpoint searchService

The service endpoint for requesting search results from a search domain.

Class com.amazonaws.services.cloudsearchv2.model.DoubleArrayOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sourceFields

String sourceFields

A list of source fields to map to the field.

Class com.amazonaws.services.cloudsearchv2.model.DoubleOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sortEnabled

Boolean sortEnabled

Whether the field can be used to sort the search results.

sourceField

String sourceField

The name of the source field to map to the field.

Class com.amazonaws.services.cloudsearchv2.model.Expression

class Expression extends Object implements Serializable

Serialized Fields

expressionName

String expressionName

expressionValue

String expressionValue

Class com.amazonaws.services.cloudsearchv2.model.ExpressionStatus

class 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

Class com.amazonaws.services.cloudsearchv2.model.IndexDocumentsRequest

class IndexDocumentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

Class com.amazonaws.services.cloudsearchv2.model.IndexDocumentsResult

class IndexDocumentsResult extends Object implements Serializable

Serialized Fields

fieldNames

com.amazonaws.internal.SdkInternalList<String> fieldNames

The names of the fields that are currently being indexed.

Class com.amazonaws.services.cloudsearchv2.model.IndexField

class IndexField extends Object implements Serializable

Serialized Fields

dateArrayOptions

DateArrayOptions dateArrayOptions

dateOptions

DateOptions dateOptions

doubleArrayOptions

DoubleArrayOptions doubleArrayOptions

doubleOptions

DoubleOptions doubleOptions

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 .

indexFieldType

String indexFieldType

intArrayOptions

IntArrayOptions intArrayOptions

intOptions

IntOptions intOptions

latLonOptions

LatLonOptions latLonOptions

literalArrayOptions

LiteralArrayOptions literalArrayOptions

literalOptions

LiteralOptions literalOptions

textArrayOptions

TextArrayOptions textArrayOptions

textOptions

TextOptions textOptions

Class com.amazonaws.services.cloudsearchv2.model.IndexFieldStatus

class IndexFieldStatus extends Object implements Serializable

Serialized Fields

options

IndexField options

status

OptionStatus status

Class com.amazonaws.services.cloudsearchv2.model.IntArrayOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sourceFields

String sourceFields

A list of source fields to map to the field.

Exception Class com.amazonaws.services.cloudsearchv2.model.InternalException

class InternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudsearchv2.model.IntOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sortEnabled

Boolean sortEnabled

Whether the field can be used to sort the search results.

sourceField

String sourceField

The name of the source field to map to the field.

Exception Class com.amazonaws.services.cloudsearchv2.model.InvalidTypeException

class InvalidTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudsearchv2.model.LatLonOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sortEnabled

Boolean sortEnabled

Whether the field can be used to sort the search results.

sourceField

String sourceField

Exception Class com.amazonaws.services.cloudsearchv2.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudsearchv2.model.Limits

class Limits extends Object implements Serializable

Serialized Fields

maximumPartitionCount

Integer maximumPartitionCount

maximumReplicationCount

Integer maximumReplicationCount

Class com.amazonaws.services.cloudsearchv2.model.ListDomainNamesRequest

class ListDomainNamesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.cloudsearchv2.model.ListDomainNamesResult

class ListDomainNamesResult extends Object implements Serializable

Serialized Fields

domainNames

com.amazonaws.internal.SdkInternalMap<String,String> domainNames

The names of the search domains owned by an account.

Class com.amazonaws.services.cloudsearchv2.model.LiteralArrayOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sourceFields

String sourceFields

A list of source fields to map to the field.

Class com.amazonaws.services.cloudsearchv2.model.LiteralOptions

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

facetEnabled

Boolean facetEnabled

Whether facet information can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

searchEnabled

Boolean searchEnabled

Whether the contents of the field are searchable.

sortEnabled

Boolean sortEnabled

Whether the field can be used to sort the search results.

sourceField

String sourceField

Class com.amazonaws.services.cloudsearchv2.model.OptionStatus

class OptionStatus extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

A timestamp for when this option was created.

pendingDeletion

Boolean pendingDeletion

Indicates that the option will be deleted once processing is complete.

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.

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.

Exception Class com.amazonaws.services.cloudsearchv2.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudsearchv2.model.ScalingParameters

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

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.

desiredReplicationCount

Integer desiredReplicationCount

The number of replicas you want to preconfigure for each index partition.

Class com.amazonaws.services.cloudsearchv2.model.ScalingParametersStatus

class ScalingParametersStatus extends Object implements Serializable

Serialized Fields

options

ScalingParameters options

status

OptionStatus status

Class com.amazonaws.services.cloudsearchv2.model.ServiceEndpoint

class ServiceEndpoint extends Object implements Serializable

Serialized Fields

endpoint

String endpoint

Class com.amazonaws.services.cloudsearchv2.model.Suggester

class Suggester extends Object implements Serializable

Serialized Fields

documentSuggesterOptions

DocumentSuggesterOptions documentSuggesterOptions

suggesterName

String suggesterName

Class com.amazonaws.services.cloudsearchv2.model.SuggesterStatus

class SuggesterStatus extends Object implements Serializable

Serialized Fields

options

Suggester options

status

OptionStatus status

Class com.amazonaws.services.cloudsearchv2.model.TextArrayOptions

class TextArrayOptions extends Object implements Serializable

Serialized Fields

analysisScheme

String analysisScheme

The name of an analysis scheme for a text-array field.

defaultValue

String defaultValue

A value to use for the field if the field isn't specified for a document.

highlightEnabled

Boolean highlightEnabled

Whether highlights can be returned for the field.

returnEnabled

Boolean returnEnabled

Whether the contents of the field can be returned in the search results.

sourceFields

String sourceFields

A list of source fields to map to the field.

Class com.amazonaws.services.cloudsearchv2.model.TextOptions

class TextOptions extends Object implements Serializable

Serialized Fields

analysisScheme

String analysisScheme

The name of an analysis scheme for a text field.

defaultValue

String defaultValue

A value to use for the field if the field isn't specified for a document.

highlightEnabled

Boolean highlightEnabled

Whether highlights can be returned for the field.

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.

sourceField

String sourceField

Class com.amazonaws.services.cloudsearchv2.model.UpdateAvailabilityOptionsRequest

class UpdateAvailabilityOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

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

class 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

class UpdateScalingParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainName

String domainName

scalingParameters

ScalingParameters scalingParameters

Class com.amazonaws.services.cloudsearchv2.model.UpdateScalingParametersResult

class UpdateScalingParametersResult extends Object implements Serializable

Serialized Fields

scalingParameters

ScalingParametersStatus scalingParameters

Class com.amazonaws.services.cloudsearchv2.model.UpdateServiceAccessPoliciesRequest

class UpdateServiceAccessPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessPolicies

String accessPolicies

The access rules you want to configure. These rules replace any existing rules.

domainName

String domainName

Class com.amazonaws.services.cloudsearchv2.model.UpdateServiceAccessPoliciesResult

class 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

class 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<Tag> tagsList

Contains a list of CloudTrail tags, up to a limit of 10.

Class com.amazonaws.services.cloudtrail.model.AddTagsResult

class AddTagsResult extends Object implements Serializable

Exception Class com.amazonaws.services.cloudtrail.model.CloudTrailARNInvalidException

class CloudTrailARNInvalidException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.CloudWatchLogsDeliveryUnavailableException

class CloudWatchLogsDeliveryUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudtrail.model.CreateTrailRequest

class CreateTrailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

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

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.

Class com.amazonaws.services.cloudtrail.model.CreateTrailResult

class CreateTrailResult extends Object implements Serializable

Serialized Fields

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.

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.

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

logFileValidationEnabled

Boolean logFileValidationEnabled

Specifies whether log file integrity validation is enabled.

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.

snsTopicARN

String snsTopicARN

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-1:123456789012:MyTopic

snsTopicName

String snsTopicName

Deprecated.

Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.

trailARN

String trailARN

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Class com.amazonaws.services.cloudtrail.model.DeleteTrailRequest

class 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

class DeleteTrailResult extends Object implements Serializable

Class com.amazonaws.services.cloudtrail.model.DescribeTrailsRequest

class DescribeTrailsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

trailNameList

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.cloudtrail.model.DescribeTrailsResult

class DescribeTrailsResult extends Object implements Serializable

Serialized Fields

trailList

com.amazonaws.internal.SdkInternalList<Trail> trailList

The list of trail objects.

Class com.amazonaws.services.cloudtrail.model.Event

class Event extends Object implements Serializable

Serialized Fields

cloudTrailEvent

String cloudTrailEvent

A JSON string that contains a representation of the event returned.

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.

resources

com.amazonaws.internal.SdkInternalList<Resource> resources

A list of resources referenced by the event returned.

username

String username

A user name or role name of the requester that called the API in the event returned.

Class com.amazonaws.services.cloudtrail.model.GetTrailStatusRequest

class 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

class GetTrailStatusResult extends Object implements Serializable

Serialized Fields

isLogging

Boolean isLogging

Whether the CloudTrail is currently logging AWS API calls.

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.

latestDeliveryAttemptSucceeded

String latestDeliveryAttemptSucceeded

This field is deprecated.

latestDeliveryAttemptTime

String latestDeliveryAttemptTime

This field is deprecated.

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.

latestDeliveryTime

Date latestDeliveryTime

Specifies the date and time that CloudTrail last delivered log files 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.

latestDigestDeliveryTime

Date latestDigestDeliveryTime

Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.

latestNotificationAttemptSucceeded

String latestNotificationAttemptSucceeded

This field is deprecated.

latestNotificationAttemptTime

String latestNotificationAttemptTime

This field is deprecated.

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.

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.

timeLoggingStarted

String timeLoggingStarted

This field is deprecated.

timeLoggingStopped

String timeLoggingStopped

This field is deprecated.

Exception Class com.amazonaws.services.cloudtrail.model.InsufficientEncryptionPolicyException

class InsufficientEncryptionPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InsufficientS3BucketPolicyException

class InsufficientS3BucketPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InsufficientSnsTopicPolicyException

class InsufficientSnsTopicPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidCloudWatchLogsLogGroupArnException

class InvalidCloudWatchLogsLogGroupArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidCloudWatchLogsRoleArnException

class InvalidCloudWatchLogsRoleArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidHomeRegionException

class InvalidHomeRegionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidKmsKeyIdException

class InvalidKmsKeyIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidLookupAttributesException

class InvalidLookupAttributesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidMaxResultsException

class InvalidMaxResultsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidParameterCombinationException

class InvalidParameterCombinationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidS3BucketNameException

class InvalidS3BucketNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidS3PrefixException

class InvalidS3PrefixException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidSnsTopicNameException

class InvalidSnsTopicNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidTagParameterException

class InvalidTagParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidTimeRangeException

class InvalidTimeRangeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidTokenException

class InvalidTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.InvalidTrailNameException

class InvalidTrailNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.KmsKeyDisabledException

class KmsKeyDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.KmsKeyNotFoundException

class KmsKeyNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudtrail.model.ListPublicKeysRequest

class ListPublicKeysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.cloudtrail.model.ListPublicKeysResult

class ListPublicKeysResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

Reserved for future use.

publicKeyList

com.amazonaws.internal.SdkInternalList<PublicKey> publicKeyList

Contains an array of PublicKey objects.

The returned public keys may have validity time ranges that overlap.

Class com.amazonaws.services.cloudtrail.model.ListTagsRequest

class ListTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

Reserved for future use.

resourceIdList

com.amazonaws.internal.SdkInternalList<String> 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

Class com.amazonaws.services.cloudtrail.model.ListTagsResult

class ListTagsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

Reserved for future use.

resourceTagList

com.amazonaws.internal.SdkInternalList<ResourceTag> resourceTagList

Class com.amazonaws.services.cloudtrail.model.LookupAttribute

class 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

class LookupEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

lookupAttributes

com.amazonaws.internal.SdkInternalList<LookupAttribute> lookupAttributes

Contains a list of lookup attributes. Currently the list can contain only one item.

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.

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.

Class com.amazonaws.services.cloudtrail.model.LookupEventsResult

class LookupEventsResult extends Object implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalList<Event> 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.

Exception Class com.amazonaws.services.cloudtrail.model.MaximumNumberOfTrailsExceededException

class MaximumNumberOfTrailsExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.OperationNotPermittedException

class OperationNotPermittedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudtrail.model.PublicKey

class PublicKey extends Object implements Serializable

Serialized Fields

fingerprint

String fingerprint

The fingerprint of the public key.

validityEndTime

Date validityEndTime

The ending time of validity of the public key.

validityStartTime

Date validityStartTime

The starting time of validity of the public key.

value

ByteBuffer value

The DER encoded public key value in PKCS#1 format.

Class com.amazonaws.services.cloudtrail.model.RemoveTagsRequest

class 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<Tag> tagsList

Specifies a list of tags to be removed.

Class com.amazonaws.services.cloudtrail.model.RemoveTagsResult

class RemoveTagsResult extends Object implements Serializable

Class com.amazonaws.services.cloudtrail.model.Resource

class Resource extends Object implements Serializable

Serialized Fields

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.

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.

Exception Class com.amazonaws.services.cloudtrail.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudtrail.model.ResourceTag

class ResourceTag extends Object implements Serializable

Serialized Fields

resourceId

String resourceId

Specifies the ARN of the resource.

tagsList

com.amazonaws.internal.SdkInternalList<Tag> tagsList

Exception Class com.amazonaws.services.cloudtrail.model.ResourceTypeNotSupportedException

class ResourceTypeNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.S3BucketDoesNotExistException

class S3BucketDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudtrail.model.StartLoggingRequest

class 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

class StartLoggingResult extends Object implements Serializable

Class com.amazonaws.services.cloudtrail.model.StopLoggingRequest

class 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

class StopLoggingResult extends Object implements Serializable

Class com.amazonaws.services.cloudtrail.model.Tag

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

Exception Class com.amazonaws.services.cloudtrail.model.TagsLimitExceededException

class TagsLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudtrail.model.Trail

class Trail extends Object implements Serializable

Serialized Fields

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.

homeRegion

String homeRegion

The region in which the trail was created.

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.

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

logFileValidationEnabled

Boolean logFileValidationEnabled

Specifies whether log file validation is enabled.

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.

snsTopicARN

String snsTopicARN

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-1:123456789012:MyTopic

snsTopicName

String snsTopicName

Deprecated.

Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.

trailARN

String trailARN

Specifies the ARN of the trail. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Exception Class com.amazonaws.services.cloudtrail.model.TrailAlreadyExistsException

class TrailAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.TrailNotFoundException

class TrailNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.TrailNotProvidedException

class TrailNotProvidedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudtrail.model.UnsupportedOperationException

class UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudtrail.model.UpdateTrailRequest

class UpdateTrailRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

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

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.

Class com.amazonaws.services.cloudtrail.model.UpdateTrailResult

class UpdateTrailResult extends Object implements Serializable

Serialized Fields

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.

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.

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

logFileValidationEnabled

Boolean logFileValidationEnabled

Specifies whether log file integrity validation is enabled.

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.

snsTopicARN

String snsTopicARN

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-1:123456789012:MyTopic

snsTopicName

String snsTopicName

Deprecated.

Specifies the name of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.

trailARN

String trailARN

Specifies the ARN of the trail that was updated. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

Package com.amazonaws.services.cloudwatch.model

Class com.amazonaws.services.cloudwatch.model.AlarmHistoryItem

class AlarmHistoryItem extends Object implements Serializable

Serialized Fields

alarmName

String alarmName

The descriptive name for the alarm.

historyData

String historyData

Machine-readable data about the alarm in JSON format.

historyItemType

String historyItemType

The type of alarm history item.

historySummary

String historySummary

A human-readable summary of the alarm history.

timestamp

Date timestamp

The time stamp for the alarm history item.

Class com.amazonaws.services.cloudwatch.model.Datapoint

class Datapoint extends Object implements Serializable

Serialized Fields

average

Double average

The average of metric values that correspond to the datapoint.

maximum

Double maximum

The maximum of the metric value used for the datapoint.

minimum

Double minimum

The minimum metric value used for the datapoint.

sampleCount

Double sampleCount

The number of metric values that contributed to the aggregate value of this datapoint.

sum

Double sum

The sum of metric values used for the datapoint.

timestamp

Date timestamp

The time stamp used for the datapoint.

unit

String unit

The standard unit used for the datapoint.

Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsRequest

class DeleteAlarmsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

com.amazonaws.internal.SdkInternalList<String> alarmNames

A list of alarms to be deleted.

Class com.amazonaws.services.cloudwatch.model.DeleteAlarmsResult

class DeleteAlarmsResult extends Object implements Serializable

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryRequest

class DescribeAlarmHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmName

String alarmName

The name of the alarm.

endDate

Date endDate

The ending date to retrieve alarm history.

historyItemType

String historyItemType

The type of alarm histories to retrieve.

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.

startDate

Date startDate

The starting date to retrieve alarm history.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmHistoryResult

class DescribeAlarmHistoryResult extends Object implements Serializable

Serialized Fields

alarmHistoryItems

com.amazonaws.internal.SdkInternalList<AlarmHistoryItem> 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

class DescribeAlarmsForMetricRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensions

com.amazonaws.internal.SdkInternalList<Dimension> 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.

metricName

String metricName

The name of the metric.

namespace

String namespace

The namespace of the metric.

period

Integer period

The period in seconds over which the statistic is applied.

statistic

String statistic

The statistic for the metric.

unit

String unit

The unit for the metric.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsForMetricResult

class DescribeAlarmsForMetricResult extends Object implements Serializable

Serialized Fields

metricAlarms

com.amazonaws.internal.SdkInternalList<MetricAlarm> metricAlarms

A list of information for each alarm with the specified metric.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsRequest

class DescribeAlarmsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionPrefix

String actionPrefix

The action name prefix.

alarmNamePrefix

String alarmNamePrefix

The alarm name prefix. AlarmNames cannot be specified if this parameter is specified.

alarmNames

com.amazonaws.internal.SdkInternalList<String> alarmNames

A list of alarm names to retrieve information for.

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.

stateValue

String stateValue

The state value to be used in matching alarms.

Class com.amazonaws.services.cloudwatch.model.DescribeAlarmsResult

class DescribeAlarmsResult extends Object implements Serializable

Serialized Fields

metricAlarms

com.amazonaws.internal.SdkInternalList<MetricAlarm> 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

class 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

class 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

class DisableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

com.amazonaws.internal.SdkInternalList<String> alarmNames

The names of the alarms to disable actions for.

Class com.amazonaws.services.cloudwatch.model.DisableAlarmActionsResult

class DisableAlarmActionsResult extends Object implements Serializable

Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsRequest

class EnableAlarmActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

alarmNames

com.amazonaws.internal.SdkInternalList<String> alarmNames

The names of the alarms to enable actions for.

Class com.amazonaws.services.cloudwatch.model.EnableAlarmActionsResult

class EnableAlarmActionsResult extends Object implements Serializable

Class com.amazonaws.services.cloudwatch.model.GetMetricStatisticsRequest

class GetMetricStatisticsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensions

com.amazonaws.internal.SdkInternalList<Dimension> dimensions

A list of dimensions describing qualities of the metric.

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

metricName

String metricName

The name of the metric, with or without spaces.

namespace

String namespace

The namespace of the metric, with or without spaces.

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.

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.

statistics

com.amazonaws.internal.SdkInternalList<String> 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

class GetMetricStatisticsResult extends Object implements Serializable

Serialized Fields

datapoints

com.amazonaws.internal.SdkInternalList<Datapoint> datapoints

The datapoints for the specified metric.

label

String label

A label describing the specified metric.

Exception Class com.amazonaws.services.cloudwatch.model.InternalServiceException

class InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudwatch.model.InvalidFormatException

class InvalidFormatException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudwatch.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudwatch.model.InvalidParameterCombinationException

class InvalidParameterCombinationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudwatch.model.InvalidParameterValueException

class InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudwatch.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.ListMetricsRequest

class ListMetricsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dimensions

com.amazonaws.internal.SdkInternalList<DimensionFilter> dimensions

A list of dimensions to filter against.

metricName

String metricName

The name of the metric to filter against.

namespace

String namespace

The namespace 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

class ListMetricsResult extends Object implements Serializable

Serialized Fields

metrics

com.amazonaws.internal.SdkInternalList<Metric> 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

class Metric extends Object implements Serializable

Serialized Fields

dimensions

com.amazonaws.internal.SdkInternalList<Dimension> dimensions

A list of dimensions associated with the metric.

metricName

String metricName

The name of the metric.

namespace

String namespace

The namespace of the metric.

Class com.amazonaws.services.cloudwatch.model.MetricAlarm

class MetricAlarm extends Object implements Serializable

Serialized Fields

actionsEnabled

Boolean actionsEnabled

Indicates whether actions should be executed during any changes to the alarm's state.

alarmActions

com.amazonaws.internal.SdkInternalList<String> 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).

alarmArn

String alarmArn

The Amazon Resource Name (ARN) of the alarm.

alarmConfigurationUpdatedTimestamp

Date alarmConfigurationUpdatedTimestamp

The time stamp of the last update to the alarm configuration.

alarmDescription

String alarmDescription

The description for the alarm.

alarmName

String alarmName

The name of the alarm.

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.

dimensions

com.amazonaws.internal.SdkInternalList<Dimension> dimensions

The list of dimensions associated with the alarm's associated metric.

evaluationPeriods

Integer evaluationPeriods

The number of periods over which data is compared to the specified threshold.

insufficientDataActions

com.amazonaws.internal.SdkInternalList<String> 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.

metricName

String metricName

The name of the alarm's metric.

namespace

String namespace

The namespace of alarm's associated metric.

oKActions

com.amazonaws.internal.SdkInternalList<String> 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).

period

Integer period

The period in seconds over which the statistic is applied.

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.

stateValue

String stateValue

The state value for the alarm.

statistic

String statistic

The statistic to apply to the alarm's associated metric.

threshold

Double threshold

The value against which the specified statistic is compared.

unit

String unit

The unit of the alarm's associated metric.

Class com.amazonaws.services.cloudwatch.model.MetricDatum

class MetricDatum extends Object implements Serializable

Serialized Fields

dimensions

com.amazonaws.internal.SdkInternalList<Dimension> 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).

metricName

String metricName

The name of the metric.

statisticValues

StatisticSet statisticValues

A set of statistical values describing the metric.

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.

unit

String unit

The unit of the metric.

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.

Exception Class com.amazonaws.services.cloudwatch.model.MissingRequiredParameterException

class MissingRequiredParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmRequest

class PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionsEnabled

Boolean actionsEnabled

Indicates whether or not actions should be executed during any changes to the alarm's state.

alarmActions

com.amazonaws.internal.SdkInternalList<String> 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.

alarmDescription

String alarmDescription

The description for the alarm.

alarmName

String alarmName

The descriptive name for the alarm. This name must be unique within the user's AWS account

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.

dimensions

com.amazonaws.internal.SdkInternalList<Dimension> dimensions

The dimensions for the alarm's associated metric.

evaluationPeriods

Integer evaluationPeriods

The number of periods over which data is compared to the specified threshold.

insufficientDataActions

com.amazonaws.internal.SdkInternalList<String> 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.

oKActions

com.amazonaws.internal.SdkInternalList<String> 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.

period

Integer period

The period in seconds over which the specified statistic is applied.

statistic

String statistic

The statistic to apply to the alarm's associated metric.

threshold

Double threshold

The value against which the specified statistic is compared.

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.

Class com.amazonaws.services.cloudwatch.model.PutMetricAlarmResult

class PutMetricAlarmResult extends Object implements Serializable

Class com.amazonaws.services.cloudwatch.model.PutMetricDataRequest

class PutMetricDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

metricData

com.amazonaws.internal.SdkInternalList<MetricDatum> metricData

A list of data describing the metric.

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.

Class com.amazonaws.services.cloudwatch.model.PutMetricDataResult

class PutMetricDataResult extends Object implements Serializable

Exception Class com.amazonaws.services.cloudwatch.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatch.model.SetAlarmStateRequest

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

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)

stateValue

String stateValue

The value of the state.

Class com.amazonaws.services.cloudwatch.model.SetAlarmStateResult

class SetAlarmStateResult extends Object implements Serializable

Class com.amazonaws.services.cloudwatch.model.StatisticSet

class StatisticSet extends Object implements Serializable

Serialized Fields

maximum

Double maximum

The maximum value of the sample set.

minimum

Double minimum

The minimum value of the sample set.

sampleCount

Double sampleCount

The number of samples used for the statistic set.

sum

Double sum

The sum of values for the sample set.

Package com.amazonaws.services.cloudwatchevents.model

Exception Class com.amazonaws.services.cloudwatchevents.model.ConcurrentModificationException

class ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleRequest

class DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the rule to be deleted.

Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleResult

class DeleteRuleResult extends Object implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleRequest

class 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

class DescribeRuleResult extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN) associated with the rule.

description

String description

The rule's description.

eventPattern

String eventPattern

The event pattern.

name

String name

The rule's name.

roleArn

String roleArn

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

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.

Class com.amazonaws.services.cloudwatchevents.model.DisableRuleRequest

class 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.DisableRuleResult

class DisableRuleResult extends Object implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.EnableRuleRequest

class 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.EnableRuleResult

class EnableRuleResult extends Object implements Serializable

Exception Class com.amazonaws.services.cloudwatchevents.model.InternalException

class InternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudwatchevents.model.InvalidEventPatternException

class InvalidEventPatternException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cloudwatchevents.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetRequest

class ListRuleNamesByTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

Integer limit

The maximum number of results to return.

nextToken

String nextToken

The token returned by a previous call to indicate that there is more data available.

targetArn

String targetArn

The Amazon Resource Name (ARN) of the target resource that you want to list the rules for.

Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetResult

class ListRuleNamesByTargetResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

Indicates that there are additional results to retrieve.

ruleNames

List<String> ruleNames

List of rules names that can invoke the given target.

Class com.amazonaws.services.cloudwatchevents.model.ListRulesRequest

class ListRulesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

Integer limit

The maximum number of results to return.

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.

Class com.amazonaws.services.cloudwatchevents.model.ListRulesResult

class ListRulesResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

Indicates that there are additional results to retrieve.

rules

List<Rule> rules

List of rules matching the specified criteria.

Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleRequest

class ListTargetsByRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

Integer limit

The maximum number of results to return.

nextToken

String nextToken

The token returned by a previous call to indicate that there is more data available.

rule

String rule

The name of the rule whose targets you want to list.

Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleResult

class ListTargetsByRuleResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

Indicates that there are additional results to retrieve.

targets

List<Target> targets

Lists the targets assigned to the rule.

Class com.amazonaws.services.cloudwatchevents.model.PutEventsRequest

class PutEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

entries

List<PutEventsRequestEntry> 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

class PutEventsRequestEntry extends Object implements Serializable

Serialized Fields

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.

detailType

String detailType

Free-form string used to decide what fields to expect in the event detail.

resources

List<String> resources

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

source

String source

The source of the event.

time

Date time

Timestamp of event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call will be used.

Class com.amazonaws.services.cloudwatchevents.model.PutEventsResult

class PutEventsResult extends Object implements Serializable

Serialized Fields

entries

List<PutEventsResultEntry> 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.

failedEntryCount

Integer failedEntryCount

The number of failed entries.

Class com.amazonaws.services.cloudwatchevents.model.PutEventsResultEntry

class PutEventsResultEntry extends Object implements Serializable

Serialized Fields

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.

eventId

String eventId

The ID of the event submitted to Amazon CloudWatch Events.

Class com.amazonaws.services.cloudwatchevents.model.PutRuleRequest

class PutRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

A description of the rule.

eventPattern

String eventPattern

The event pattern.

name

String name

The name of the rule that you are creating or updating.

roleArn

String roleArn

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

scheduleExpression

String scheduleExpression

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

state

String state

Indicates whether the rule is enabled or disabled.

Class com.amazonaws.services.cloudwatchevents.model.PutRuleResult

class 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

class PutTargetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

rule

String rule

The name of the rule you want to add targets to.

targets

List<Target> targets

List of targets you want to update or add to the rule.

Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResult

class PutTargetsResult extends Object implements Serializable

Serialized Fields

failedEntries

List<PutTargetsResultEntry> failedEntries

An array of failed target entries.

failedEntryCount

Integer failedEntryCount

The number of failed entries.

Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResultEntry

class PutTargetsResultEntry extends Object implements Serializable

Serialized Fields

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.

targetId

String targetId

The ID of the target submitted to Amazon CloudWatch Events.

Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsRequest

class RemoveTargetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ids

List<String> ids

The list of target IDs to remove from the rule.

rule

String rule

The name of the rule you want to remove targets from.

Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResult

class RemoveTargetsResult extends Object implements Serializable

Serialized Fields

failedEntries

List<RemoveTargetsResultEntry> failedEntries

An array of failed target entries.

failedEntryCount

Integer failedEntryCount

The number of failed entries.

Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResultEntry

class RemoveTargetsResultEntry extends Object implements Serializable

Serialized Fields

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.

targetId

String targetId

The ID of the target requested to be removed by Amazon CloudWatch Events.

Exception Class com.amazonaws.services.cloudwatchevents.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cloudwatchevents.model.Rule

class Rule extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN) of the rule.

description

String description

The description of the rule.

eventPattern

String eventPattern

The event pattern of the rule.

name

String name

The rule's name.

roleArn

String roleArn

The Amazon Resource Name (ARN) associated with the role that is used for target invocation.

scheduleExpression

String scheduleExpression

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

state

String state

The rule's state.

Class com.amazonaws.services.cloudwatchevents.model.Target

class Target extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN) associated of the target.

id

String id

The unique target assignment ID.

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

class TestEventPatternRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

event

String event

The event in the JSON format to test against the event pattern.

eventPattern

String eventPattern

The event pattern you want to test.

Class com.amazonaws.services.cloudwatchevents.model.TestEventPatternResult

class 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

class BatchGetRepositoriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

repositoryNames

List<String> repositoryNames

The names of the repositories to get information about.

Class com.amazonaws.services.codecommit.model.BatchGetRepositoriesResult

class BatchGetRepositoriesResult extends Object implements Serializable

Serialized Fields

repositories

List<RepositoryMetadata> repositories

A list of repositories returned by the batch get repositories operation.

repositoriesNotFound

List<String> repositoriesNotFound

Returns a list of repository names for which information could not be found.

Exception Class com.amazonaws.services.codecommit.model.BranchDoesNotExistException

class BranchDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.BranchInfo

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

Exception Class com.amazonaws.services.codecommit.model.BranchNameExistsException

class BranchNameExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.BranchNameRequiredException

class BranchNameRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.Commit

class Commit extends Object implements Serializable

Serialized Fields

additionalData

String additionalData

Any additional data 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.

message

String message

The message associated with the specified commit.

parents

List<String> parents

The parent list for the specified commit.

treeId

String treeId

Tree information for the specified commit.

Exception Class com.amazonaws.services.codecommit.model.CommitDoesNotExistException

class CommitDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.CommitIdDoesNotExistException

class CommitIdDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.CommitIdRequiredException

class CommitIdRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.CreateBranchRequest

class CreateBranchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

repositoryName

String repositoryName

The name of the repository in which you want to create the new branch.

Class com.amazonaws.services.codecommit.model.CreateBranchResult

class CreateBranchResult extends Object implements Serializable

Class com.amazonaws.services.codecommit.model.CreateRepositoryRequest

class CreateRepositoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.codecommit.model.CreateRepositoryResult

class CreateRepositoryResult extends Object implements Serializable

Serialized Fields

repositoryMetadata

RepositoryMetadata repositoryMetadata

Information about the newly created repository.

Class com.amazonaws.services.codecommit.model.DeleteRepositoryRequest

class DeleteRepositoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

repositoryName

String repositoryName

The name of the repository to delete.

Class com.amazonaws.services.codecommit.model.DeleteRepositoryResult

class DeleteRepositoryResult extends Object implements Serializable

Serialized Fields

repositoryId

String repositoryId

The ID of the repository that was deleted.

Exception Class com.amazonaws.services.codecommit.model.EncryptionIntegrityChecksFailedException

class EncryptionIntegrityChecksFailedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.EncryptionKeyAccessDeniedException

class EncryptionKeyAccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.EncryptionKeyDisabledException

class EncryptionKeyDisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.EncryptionKeyNotFoundException

class EncryptionKeyNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.EncryptionKeyUnavailableException

class EncryptionKeyUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.GetBranchRequest

class GetBranchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

branchName

String branchName

The name of the branch for which you want to retrieve information.

repositoryName

String repositoryName

The name of the repository that contains the branch for which you want to retrieve information.

Class com.amazonaws.services.codecommit.model.GetBranchResult

class GetBranchResult extends Object implements Serializable

Serialized Fields

branch

BranchInfo branch

The name of the branch.

Class com.amazonaws.services.codecommit.model.GetCommitRequest

class GetCommitRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

commitId

String commitId

The commit ID.

repositoryName

String repositoryName

The name of the repository to which the commit was made.

Class com.amazonaws.services.codecommit.model.GetCommitResult

class GetCommitResult extends Object implements Serializable

Serialized Fields

commit

Commit commit

Information about the specified commit.

Class com.amazonaws.services.codecommit.model.GetRepositoryRequest

class 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

class GetRepositoryResult extends Object implements Serializable

Serialized Fields

repositoryMetadata

RepositoryMetadata repositoryMetadata

Information about the repository.

Class com.amazonaws.services.codecommit.model.GetRepositoryTriggersRequest

class 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

class GetRepositoryTriggersResult extends Object implements Serializable

Serialized Fields

configurationId

String configurationId

The system-generated unique ID for the trigger.

triggers

List<RepositoryTrigger> triggers

The JSON block of configuration information for each trigger.

Exception Class com.amazonaws.services.codecommit.model.InvalidBranchNameException

class InvalidBranchNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidCommitIdException

class InvalidCommitIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidContinuationTokenException

class InvalidContinuationTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidOrderException

class InvalidOrderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryDescriptionException

class InvalidRepositoryDescriptionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryNameException

class InvalidRepositoryNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerBranchNameException

class InvalidRepositoryTriggerBranchNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerCustomDataException

class InvalidRepositoryTriggerCustomDataException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerDestinationArnException

class InvalidRepositoryTriggerDestinationArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerEventsException

class InvalidRepositoryTriggerEventsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerNameException

class InvalidRepositoryTriggerNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidRepositoryTriggerRegionException

class InvalidRepositoryTriggerRegionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.InvalidSortByException

class InvalidSortByException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.ListBranchesRequest

class ListBranchesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextToken

String nextToken

An enumeration token that allows the operation to batch the results.

repositoryName

String repositoryName

The name of the repository that contains the branches.

Class com.amazonaws.services.codecommit.model.ListBranchesResult

class ListBranchesResult extends Object implements Serializable

Serialized Fields

branches

List<String> 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

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

order

String order

The order in which to sort the results of a list repositories operation.

sortBy

String sortBy

The criteria used to sort the results of a list repositories operation.

Class com.amazonaws.services.codecommit.model.ListRepositoriesResult

class ListRepositoriesResult extends Object 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.

repositories

List<RepositoryNameIdPair> repositories

Lists the repositories called by the list repositories operation.

Exception Class com.amazonaws.services.codecommit.model.MaximumBranchesExceededException

class MaximumBranchesExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.MaximumRepositoryNamesExceededException

class MaximumRepositoryNamesExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.MaximumRepositoryTriggersExceededException

class MaximumRepositoryTriggersExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.PutRepositoryTriggersRequest

class 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<RepositoryTrigger> triggers

The JSON block of configuration information for each trigger.

Class com.amazonaws.services.codecommit.model.PutRepositoryTriggersResult

class PutRepositoryTriggersResult extends Object implements Serializable

Serialized Fields

configurationId

String configurationId

The system-generated unique ID for the create or update operation.

Exception Class com.amazonaws.services.codecommit.model.RepositoryDoesNotExistException

class RepositoryDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.RepositoryLimitExceededException

class RepositoryLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.RepositoryMetadata

class RepositoryMetadata extends Object implements Serializable

Serialized Fields

accountId

String accountId

The ID of the AWS account associated with the repository.

arn

String arn

The Amazon Resource Name (ARN) of the repository.

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.

creationDate

Date creationDate

The date and time the repository was created, in timestamp format.

defaultBranch

String defaultBranch

The repository's default branch name.

lastModifiedDate

Date lastModifiedDate

The date and time the repository was last modified, in timestamp format.

repositoryDescription

String repositoryDescription

A comment or description about the repository.

repositoryId

String repositoryId

The ID of the repository.

repositoryName

String repositoryName

The repository's name.

Exception Class com.amazonaws.services.codecommit.model.RepositoryNameExistsException

class RepositoryNameExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.RepositoryNameIdPair

class RepositoryNameIdPair extends Object implements Serializable

Serialized Fields

repositoryId

String repositoryId

The ID associated with the repository.

repositoryName

String repositoryName

The name associated with the repository.

Exception Class com.amazonaws.services.codecommit.model.RepositoryNameRequiredException

class RepositoryNameRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.RepositoryNamesRequiredException

class RepositoryNamesRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.RepositoryTrigger

class RepositoryTrigger extends Object implements Serializable

Serialized Fields

branches

List<String> branches

The branches that will be included in the trigger configuration. If no branches are specified, the trigger will apply to all branches.

customData

String customData

Any custom data associated with the trigger that will be included in the information sent to the target 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).

events

List<String> 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.

name

String name

The name of the trigger.

Exception Class com.amazonaws.services.codecommit.model.RepositoryTriggerBranchNameListRequiredException

class RepositoryTriggerBranchNameListRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.RepositoryTriggerDestinationArnRequiredException

class RepositoryTriggerDestinationArnRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.RepositoryTriggerEventsListRequiredException

class RepositoryTriggerEventsListRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.RepositoryTriggerExecutionFailure

class RepositoryTriggerExecutionFailure extends Object implements Serializable

Serialized Fields

failureMessage

String failureMessage

Additional message information about the trigger that did not run.

trigger

String trigger

The name of the trigger that did not run.

Exception Class com.amazonaws.services.codecommit.model.RepositoryTriggerNameRequiredException

class RepositoryTriggerNameRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codecommit.model.RepositoryTriggersListRequiredException

class RepositoryTriggersListRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codecommit.model.TestRepositoryTriggersRequest

class TestRepositoryTriggersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

repositoryName

String repositoryName

The name of the repository in which to test the triggers.

triggers

List<RepositoryTrigger> triggers

The list of triggers to test.

Class com.amazonaws.services.codecommit.model.TestRepositoryTriggersResult

class TestRepositoryTriggersResult extends Object implements Serializable

Serialized Fields

failedExecutions

List<RepositoryTriggerExecutionFailure> 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.

successfulExecutions

List<String> successfulExecutions

The list of triggers that were successfully tested. This list provides the names of the triggers that were successfully tested, separated by commas.

Class com.amazonaws.services.codecommit.model.UpdateDefaultBranchRequest

class UpdateDefaultBranchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

defaultBranchName

String defaultBranchName

The name of the branch to set as the default.

repositoryName

String repositoryName

The name of the repository to set or change the default branch for.

Class com.amazonaws.services.codecommit.model.UpdateDefaultBranchResult

class UpdateDefaultBranchResult extends Object implements Serializable

Class com.amazonaws.services.codecommit.model.UpdateRepositoryDescriptionRequest

class UpdateRepositoryDescriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

repositoryDescription

String repositoryDescription

The new comment or description for the specified repository. Repository descriptions are limited to 1,000 characters.

repositoryName

String repositoryName

The name of the repository to set or change the comment or description for.

Class com.amazonaws.services.codecommit.model.UpdateRepositoryDescriptionResult

class UpdateRepositoryDescriptionResult extends Object implements Serializable

Class com.amazonaws.services.codecommit.model.UpdateRepositoryNameRequest

class UpdateRepositoryNameRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

newName

String newName

The new name for the repository.

oldName

String oldName

The existing name of the repository.

Class com.amazonaws.services.codecommit.model.UpdateRepositoryNameResult

class UpdateRepositoryNameResult extends Object implements Serializable

Class com.amazonaws.services.codecommit.model.UserInfo

class UserInfo extends Object implements Serializable

Serialized Fields

dateValue

String dateValue

The date when the specified commit was pushed to the repository.

email

String email

The email address associated with the user who made the commit, if any.

name

String name

The name of the user who made the specified commit.

Package com.amazonaws.services.codedeploy.model

Class com.amazonaws.services.codedeploy.model.AddTagsToOnPremisesInstancesRequest

class AddTagsToOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceNames

com.amazonaws.internal.SdkInternalList<String> instanceNames

The names of the on-premises instances to which to add tags.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.

Class com.amazonaws.services.codedeploy.model.AddTagsToOnPremisesInstancesResult

class AddTagsToOnPremisesInstancesResult extends Object implements Serializable

Exception Class com.amazonaws.services.codedeploy.model.ApplicationAlreadyExistsException

class ApplicationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.ApplicationDoesNotExistException

class ApplicationDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.ApplicationInfo

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

Exception Class com.amazonaws.services.codedeploy.model.ApplicationLimitExceededException

class ApplicationLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.ApplicationNameRequiredException

class ApplicationNameRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.AutoScalingGroup

class AutoScalingGroup extends Object implements Serializable

Serialized Fields

hook

String hook

An Auto Scaling lifecycle event hook name.

name

String name

The Auto Scaling group name.

Class com.amazonaws.services.codedeploy.model.BatchGetApplicationRevisionsRequest

class 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<RevisionLocation> revisions

Information to get about the application revisions, including type and location.

Class com.amazonaws.services.codedeploy.model.BatchGetApplicationRevisionsResult

class 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<RevisionInfo> revisions

Additional information about the revisions, including the type and location.

Class com.amazonaws.services.codedeploy.model.BatchGetApplicationsRequest

class BatchGetApplicationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationNames

com.amazonaws.internal.SdkInternalList<String> applicationNames

A list of application names separated by spaces.

Class com.amazonaws.services.codedeploy.model.BatchGetApplicationsResult

class BatchGetApplicationsResult extends Object implements Serializable

Serialized Fields

applicationsInfo

com.amazonaws.internal.SdkInternalList<ApplicationInfo> applicationsInfo

Information about the applications.

Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentGroupsRequest

class 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<String> deploymentGroupNames

The deployment groups' names.

Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentGroupsResult

class BatchGetDeploymentGroupsResult extends Object implements Serializable

Serialized Fields

deploymentGroupsInfo

com.amazonaws.internal.SdkInternalList<DeploymentGroupInfo> 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

class BatchGetDeploymentInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The unique ID of a deployment.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

The unique IDs of instances in the deployment group.

Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentInstancesResult

class BatchGetDeploymentInstancesResult extends Object implements Serializable

Serialized Fields

errorMessage

String errorMessage

Information about errors that may have occurred during the API call.

instancesSummary

com.amazonaws.internal.SdkInternalList<InstanceSummary> instancesSummary

Information about the instance.

Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentsRequest

class BatchGetDeploymentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentIds

com.amazonaws.internal.SdkInternalList<String> deploymentIds

A list of deployment IDs, separated by spaces.

Class com.amazonaws.services.codedeploy.model.BatchGetDeploymentsResult

class BatchGetDeploymentsResult extends Object implements Serializable

Serialized Fields

deploymentsInfo

com.amazonaws.internal.SdkInternalList<DeploymentInfo> deploymentsInfo

Information about the deployments.

Class com.amazonaws.services.codedeploy.model.BatchGetOnPremisesInstancesRequest

class BatchGetOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceNames

com.amazonaws.internal.SdkInternalList<String> instanceNames

The names of the on-premises instances about which to get information.

Class com.amazonaws.services.codedeploy.model.BatchGetOnPremisesInstancesResult

class BatchGetOnPremisesInstancesResult extends Object implements Serializable

Serialized Fields

instanceInfos

com.amazonaws.internal.SdkInternalList<InstanceInfo> instanceInfos

Information about the on-premises instances.

Exception Class com.amazonaws.services.codedeploy.model.BatchLimitExceededException

class BatchLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.BucketNameFilterRequiredException

class BucketNameFilterRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.CreateApplicationRequest

class 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

class CreateApplicationResult extends Object implements Serializable

Serialized Fields

applicationId

String applicationId

A unique application ID.

Class com.amazonaws.services.codedeploy.model.CreateDeploymentConfigRequest

class 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

class CreateDeploymentConfigResult extends Object implements Serializable

Serialized Fields

deploymentConfigId

String deploymentConfigId

A unique deployment configuration ID.

Class com.amazonaws.services.codedeploy.model.CreateDeploymentGroupRequest

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

autoScalingGroups

com.amazonaws.internal.SdkInternalList<String> autoScalingGroups

A list of associated Auto Scaling groups.

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

deploymentGroupName

String deploymentGroupName

The name of a new deployment group for the specified application.

ec2TagFilters

com.amazonaws.internal.SdkInternalList<EC2TagFilter> ec2TagFilters

The Amazon EC2 tags on which to filter.

onPremisesInstanceTagFilters

com.amazonaws.internal.SdkInternalList<TagFilter> onPremisesInstanceTagFilters

The on-premises instance tags on which to filter.

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<TriggerConfig> triggerConfigurations

Information about triggers to create when the deployment group is created.

Class com.amazonaws.services.codedeploy.model.CreateDeploymentGroupResult

class CreateDeploymentGroupResult extends Object implements Serializable

Serialized Fields

deploymentGroupId

String deploymentGroupId

A unique deployment group ID.

Class com.amazonaws.services.codedeploy.model.CreateDeploymentRequest

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

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.

deploymentGroupName

String deploymentGroupName

The name of the deployment group.

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.

revision

RevisionLocation revision

The type and location of the revision to deploy.

Class com.amazonaws.services.codedeploy.model.CreateDeploymentResult

class CreateDeploymentResult extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

A unique deployment ID.

Class com.amazonaws.services.codedeploy.model.DeleteApplicationRequest

class 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.DeleteApplicationResult

class DeleteApplicationResult extends Object implements Serializable

Class com.amazonaws.services.codedeploy.model.DeleteDeploymentConfigRequest

class 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.DeleteDeploymentConfigResult

class DeleteDeploymentConfigResult extends Object implements Serializable

Class com.amazonaws.services.codedeploy.model.DeleteDeploymentGroupRequest

class 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

class DeleteDeploymentGroupResult extends Object implements Serializable

Serialized Fields

hooksNotCleanedUp

com.amazonaws.internal.SdkInternalList<AutoScalingGroup> 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.

Exception Class com.amazonaws.services.codedeploy.model.DeploymentAlreadyCompletedException

class DeploymentAlreadyCompletedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentConfigAlreadyExistsException

class DeploymentConfigAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentConfigDoesNotExistException

class DeploymentConfigDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.DeploymentConfigInfo

class DeploymentConfigInfo extends Object implements Serializable

Serialized Fields

createTime

Date createTime

The time at which the deployment configuration was created.

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.

Exception Class com.amazonaws.services.codedeploy.model.DeploymentConfigInUseException

class DeploymentConfigInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentConfigLimitExceededException

class DeploymentConfigLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentConfigNameRequiredException

class DeploymentConfigNameRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentDoesNotExistException

class DeploymentDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentGroupAlreadyExistsException

class DeploymentGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentGroupDoesNotExistException

class DeploymentGroupDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.DeploymentGroupInfo

class DeploymentGroupInfo extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The application name.

autoScalingGroups

com.amazonaws.internal.SdkInternalList<AutoScalingGroup> autoScalingGroups

A list of associated Auto Scaling groups.

deploymentConfigName

String deploymentConfigName

The deployment configuration name.

deploymentGroupId

String deploymentGroupId

The deployment group ID.

deploymentGroupName

String deploymentGroupName

The deployment group name.

ec2TagFilters

com.amazonaws.internal.SdkInternalList<EC2TagFilter> ec2TagFilters

The Amazon EC2 tags on which to filter.

onPremisesInstanceTagFilters

com.amazonaws.internal.SdkInternalList<TagFilter> onPremisesInstanceTagFilters

The on-premises instance tags on which to filter.

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<TriggerConfig> triggerConfigurations

A list of associated triggers.

Exception Class com.amazonaws.services.codedeploy.model.DeploymentGroupLimitExceededException

class DeploymentGroupLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentGroupNameRequiredException

class DeploymentGroupNameRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentIdRequiredException

class DeploymentIdRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.DeploymentInfo

class DeploymentInfo extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The application name.

completeTime

Date completeTime

A timestamp indicating when the deployment was complete.

createTime

Date createTime

A timestamp indicating when the deployment was created.

creator

String creator

The means by which the deployment was created:

• user: A user created the deployment.
• autoscaling: Auto Scaling created the deployment.

deploymentConfigName

String deploymentConfigName

The deployment configuration name.

deploymentGroupName

String deploymentGroupName

The deployment group name.

deploymentId

String deploymentId

The deployment ID.

deploymentOverview

DeploymentOverview deploymentOverview

A summary of the deployment status of the instances in the deployment.

description

String description

A comment about the deployment.

errorInformation

ErrorInformation errorInformation

Information about any error associated with this 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.

revision

RevisionLocation revision

Information about the location of stored application artifacts and the service from which to retrieve them.

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.

status

String status

The current state of the deployment as a whole.

Exception Class com.amazonaws.services.codedeploy.model.DeploymentLimitExceededException

class DeploymentLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.DeploymentNotStartedException

class DeploymentNotStartedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.DeploymentOverview

class DeploymentOverview extends Object implements Serializable

Serialized Fields

failed

Long failed

The number of instances in the deployment in a failed state.

inProgress

Long inProgress

The number of instances in which the deployment is in progress.

pending

Long pending

The number of instances in the deployment in a pending state.

skipped

Long skipped

The number of instances in the deployment in a skipped state.

succeeded

Long succeeded

The number of instances in the deployment to which revisions have been successfully deployed.

Class com.amazonaws.services.codedeploy.model.DeregisterOnPremisesInstanceRequest

class 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.DeregisterOnPremisesInstanceResult

class DeregisterOnPremisesInstanceResult extends Object implements Serializable

Exception Class com.amazonaws.services.codedeploy.model.DescriptionTooLongException

class DescriptionTooLongException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.Diagnostics

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

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.

message

String message

The message associated with the error.

scriptName

String scriptName

The name of the script.

Class com.amazonaws.services.codedeploy.model.EC2TagFilter

class EC2TagFilter extends Object implements Serializable

Serialized Fields

key

String key

The tag filter key.

type

String type

The tag filter type:

• KEY_ONLY: Key only.
• VALUE_ONLY: Value only.
• KEY_AND_VALUE: Key and value.

value

String value

The tag filter value.

Class com.amazonaws.services.codedeploy.model.ErrorInformation

class 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

class GenericRevisionInfo extends Object implements Serializable

Serialized Fields

deploymentGroups

com.amazonaws.internal.SdkInternalList<String> deploymentGroups

The deployment groups for which this is the current target revision.

description

String description

A comment about the 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

class 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

class GetApplicationResult extends Object implements Serializable

Serialized Fields

application

ApplicationInfo application

Information about the application.

Class com.amazonaws.services.codedeploy.model.GetApplicationRevisionRequest

class 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

class 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

class 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

class GetDeploymentConfigResult extends Object implements Serializable

Serialized Fields

deploymentConfigInfo

DeploymentConfigInfo deploymentConfigInfo

Information about the deployment configuration.

Class com.amazonaws.services.codedeploy.model.GetDeploymentGroupRequest

class 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

class GetDeploymentGroupResult extends Object implements Serializable

Serialized Fields

deploymentGroupInfo

DeploymentGroupInfo deploymentGroupInfo

Information about the deployment group.

Class com.amazonaws.services.codedeploy.model.GetDeploymentInstanceRequest

class 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

class GetDeploymentInstanceResult extends Object implements Serializable

Serialized Fields

instanceSummary

InstanceSummary instanceSummary

Information about the instance.

Class com.amazonaws.services.codedeploy.model.GetDeploymentRequest

class 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

class GetDeploymentResult extends Object implements Serializable

Serialized Fields

deploymentInfo

DeploymentInfo deploymentInfo

Information about the deployment.

Class com.amazonaws.services.codedeploy.model.GetOnPremisesInstanceRequest

class 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

class GetOnPremisesInstanceResult extends Object implements Serializable

Serialized Fields

instanceInfo

InstanceInfo instanceInfo

Information about the on-premises instance.

Class com.amazonaws.services.codedeploy.model.GitHubLocation

class GitHubLocation extends Object implements Serializable

Serialized Fields

commitId

String commitId

The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.

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.

Exception Class com.amazonaws.services.codedeploy.model.IamUserArnAlreadyRegisteredException

class IamUserArnAlreadyRegisteredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.IamUserArnRequiredException

class IamUserArnRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InstanceDoesNotExistException

class InstanceDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InstanceIdRequiredException

class InstanceIdRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.InstanceInfo

class InstanceInfo extends Object implements Serializable

Serialized Fields

deregisterTime

Date deregisterTime

If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.

iamUserArn

String iamUserArn

The IAM user ARN associated with the on-premises instance.

instanceArn

String instanceArn

The ARN of the on-premises instance.

instanceName

String instanceName

The name of the on-premises instance.

registerTime

Date registerTime

The time at which the on-premises instance was registered.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

The tags currently associated with the on-premises instance.

Exception Class com.amazonaws.services.codedeploy.model.InstanceLimitExceededException

class InstanceLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InstanceNameAlreadyRegisteredException

class InstanceNameAlreadyRegisteredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InstanceNameRequiredException

class InstanceNameRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InstanceNotRegisteredException

class InstanceNotRegisteredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.InstanceSummary

class InstanceSummary extends Object implements Serializable

Serialized Fields

deploymentId

String deploymentId

The deployment ID.

instanceId

String instanceId

The instance ID.

lastUpdatedAt

Date lastUpdatedAt

A timestamp indicating when the instance information was last updated.

lifecycleEvents

com.amazonaws.internal.SdkInternalList<LifecycleEvent> lifecycleEvents

A list of lifecycle events for this instance.

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.

Exception Class com.amazonaws.services.codedeploy.model.InvalidApplicationNameException

class InvalidApplicationNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidAutoScalingGroupException

class InvalidAutoScalingGroupException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidBucketNameFilterException

class InvalidBucketNameFilterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidDeployedStateFilterException

class InvalidDeployedStateFilterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidDeploymentConfigNameException

class InvalidDeploymentConfigNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidDeploymentGroupNameException

class InvalidDeploymentGroupNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidDeploymentIdException

class InvalidDeploymentIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidDeploymentStatusException

class InvalidDeploymentStatusException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidEC2TagException

class InvalidEC2TagException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidIamUserArnException

class InvalidIamUserArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidInstanceNameException

class InvalidInstanceNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidInstanceStatusException

class InvalidInstanceStatusException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidKeyPrefixFilterException

class InvalidKeyPrefixFilterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidMinimumHealthyHostValueException

class InvalidMinimumHealthyHostValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidOperationException

class InvalidOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidRegistrationStatusException

class InvalidRegistrationStatusException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidRevisionException

class InvalidRevisionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidRoleException

class InvalidRoleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidSortByException

class InvalidSortByException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidSortOrderException

class InvalidSortOrderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidTagException

class InvalidTagException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidTagFilterException

class InvalidTagFilterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidTimeRangeException

class InvalidTimeRangeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.InvalidTriggerConfigException

class InvalidTriggerConfigException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.LifecycleEvent

class LifecycleEvent extends Object implements Serializable

Serialized Fields

diagnostics

Diagnostics diagnostics

Diagnostic information about the deployment lifecycle event.

endTime

Date endTime

A timestamp indicating when the deployment lifecycle event ended.

lifecycleEventName

String lifecycleEventName

The deployment lifecycle event name, such as ApplicationStop, BeforeInstall, AfterInstall, ApplicationStart, or ValidateService.

startTime

Date startTime

A timestamp indicating when the deployment lifecycle event started.

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.

Exception Class com.amazonaws.services.codedeploy.model.LifecycleHookLimitExceededException

class LifecycleHookLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.ListApplicationRevisionsRequest

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

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.

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.

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.

Class com.amazonaws.services.codedeploy.model.ListApplicationRevisionsResult

class ListApplicationRevisionsResult extends Object implements Serializable

Serialized Fields

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.

revisions

com.amazonaws.internal.SdkInternalList<RevisionLocation> revisions

A list of locations that contain the matching revisions.

Class com.amazonaws.services.codedeploy.model.ListApplicationsRequest

class 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

class ListApplicationsResult extends Object implements Serializable

Serialized Fields

applications

com.amazonaws.internal.SdkInternalList<String> 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

class 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

class ListDeploymentConfigsResult extends Object implements Serializable

Serialized Fields

deploymentConfigsList

com.amazonaws.internal.SdkInternalList<String> 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

class 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

class ListDeploymentGroupsResult extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The application name.

deploymentGroups

com.amazonaws.internal.SdkInternalList<String> 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

class ListDeploymentInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The unique ID of a deployment.

instanceStatusFilter

com.amazonaws.internal.SdkInternalList<String> 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.

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.

Class com.amazonaws.services.codedeploy.model.ListDeploymentInstancesResult

class ListDeploymentInstancesResult extends Object implements Serializable

Serialized Fields

instancesList

com.amazonaws.internal.SdkInternalList<String> 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

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

createTimeRange

TimeRange createTimeRange

A time range (start and end) for returning a subset of the list of deployments.

deploymentGroupName

String deploymentGroupName

The name of an existing deployment group for the specified application.

includeOnlyStatuses

com.amazonaws.internal.SdkInternalList<String> 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.

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

class ListDeploymentsResult extends Object implements Serializable

Serialized Fields

deployments

com.amazonaws.internal.SdkInternalList<String> 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

class ListOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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<TagFilter> tagFilters

The on-premises instance tags that will be used to restrict the corresponding on-premises instance names returned.

Class com.amazonaws.services.codedeploy.model.ListOnPremisesInstancesResult

class ListOnPremisesInstancesResult extends Object implements Serializable

Serialized Fields

instanceNames

com.amazonaws.internal.SdkInternalList<String> 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

class MinimumHealthyHosts extends Object implements Serializable

Serialized Fields

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.

value

Integer value

The minimum healthy instance value.

Class com.amazonaws.services.codedeploy.model.RegisterApplicationRevisionRequest

class 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.RegisterApplicationRevisionResult

class RegisterApplicationRevisionResult extends Object implements Serializable

Class com.amazonaws.services.codedeploy.model.RegisterOnPremisesInstanceRequest

class RegisterOnPremisesInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The ARN of the IAM user to associate with the on-premises instance.

instanceName

String instanceName

The name of the on-premises instance to register.

Class com.amazonaws.services.codedeploy.model.RegisterOnPremisesInstanceResult

class RegisterOnPremisesInstanceResult extends Object implements Serializable

Class com.amazonaws.services.codedeploy.model.RemoveTagsFromOnPremisesInstancesRequest

class RemoveTagsFromOnPremisesInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceNames

com.amazonaws.internal.SdkInternalList<String> instanceNames

The names of the on-premises instances from which to remove tags.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

The tag key-value pairs to remove from the on-premises instances.

Class com.amazonaws.services.codedeploy.model.RemoveTagsFromOnPremisesInstancesResult

class RemoveTagsFromOnPremisesInstancesResult extends Object implements Serializable

Exception Class com.amazonaws.services.codedeploy.model.RevisionDoesNotExistException

class RevisionDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.RevisionInfo

class RevisionInfo extends Object implements Serializable

Serialized Fields

genericRevisionInfo

GenericRevisionInfo genericRevisionInfo

revisionLocation

RevisionLocation revisionLocation

Class com.amazonaws.services.codedeploy.model.RevisionLocation

class RevisionLocation extends Object implements Serializable

Serialized Fields

gitHubLocation

GitHubLocation gitHubLocation

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

Exception Class com.amazonaws.services.codedeploy.model.RevisionRequiredException

class RevisionRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.RoleRequiredException

class RoleRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.S3Location

class S3Location extends Object implements Serializable

Serialized Fields

bucket

String bucket

The name of the Amazon S3 bucket where the application revision is stored.

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.

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.

key

String key

The name of the Amazon S3 object that represents the bundled artifacts for the application revision.

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.

Class com.amazonaws.services.codedeploy.model.StopDeploymentRequest

class StopDeploymentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deploymentId

String deploymentId

The unique ID of a deployment.

Class com.amazonaws.services.codedeploy.model.StopDeploymentResult

class 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

class 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

class TagFilter extends Object implements Serializable

Serialized Fields

key

String key

The on-premises instance tag filter key.

type

String type

The on-premises instance tag filter type:

• KEY_ONLY: Key only.
• VALUE_ONLY: Value only.
• KEY_AND_VALUE: Key and value.

value

String value

The on-premises instance tag filter value.

Exception Class com.amazonaws.services.codedeploy.model.TagLimitExceededException

class TagLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codedeploy.model.TagRequiredException

class TagRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.TimeRange

class TimeRange extends Object implements Serializable

Serialized Fields

end

Date end

The end time of the time range.

Specify null to leave the end time open-ended.

start

Date start

The start time of the time range.

Specify null to leave the start time open-ended.

Class com.amazonaws.services.codedeploy.model.TriggerConfig

class TriggerConfig extends Object implements Serializable

Serialized Fields

triggerEvents

com.amazonaws.internal.SdkInternalList<String> 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

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.

Exception Class com.amazonaws.services.codedeploy.model.TriggerTargetsLimitExceededException

class TriggerTargetsLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codedeploy.model.UpdateApplicationRequest

class 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.UpdateApplicationResult

class UpdateApplicationResult extends Object implements Serializable

Class com.amazonaws.services.codedeploy.model.UpdateDeploymentGroupRequest

class UpdateDeploymentGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The application name corresponding to the deployment group to update.

autoScalingGroups

com.amazonaws.internal.SdkInternalList<String> 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.

currentDeploymentGroupName

String currentDeploymentGroupName

The current name of the deployment group.

deploymentConfigName

String deploymentConfigName

The replacement deployment configuration name to use, if you want to change it.

ec2TagFilters

com.amazonaws.internal.SdkInternalList<EC2TagFilter> 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.

newDeploymentGroupName

String newDeploymentGroupName

The new name of the deployment group, if you want to change it.

onPremisesInstanceTagFilters

com.amazonaws.internal.SdkInternalList<TagFilter> 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.

serviceRoleArn

String serviceRoleArn

A replacement ARN for the service role, if you want to change it.

triggerConfigurations

com.amazonaws.internal.SdkInternalList<TriggerConfig> triggerConfigurations

Information about triggers to change when the deployment group is updated.

Class com.amazonaws.services.codedeploy.model.UpdateDeploymentGroupResult

class UpdateDeploymentGroupResult extends Object implements Serializable

Serialized Fields

hooksNotCleanedUp

com.amazonaws.internal.SdkInternalList<AutoScalingGroup> 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

class 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

class 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

class AcknowledgeThirdPartyJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.codepipeline.model.AcknowledgeThirdPartyJobResult

class 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

class ActionConfiguration extends Object implements Serializable

Serialized Fields

configuration

Map<String,String> configuration

The configuration data for the action.

Class com.amazonaws.services.codepipeline.model.ActionConfigurationProperty

class ActionConfigurationProperty extends Object implements Serializable

Serialized Fields

description

String description

The description of the action configuration property that will be displayed to users.

key

Boolean key

Whether the configuration property is a key.

name

String name

The name of the action configuration property.

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.

required

Boolean required

Whether the configuration property is a required value.

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.

type

String type

The type of the configuration property.

Class com.amazonaws.services.codepipeline.model.ActionContext

class 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

class ActionDeclaration extends Object implements Serializable

Serialized Fields

actionTypeId

ActionTypeId actionTypeId

The configuration information for the action type.

configuration

Map<String,String> configuration

The action declaration's configuration.

inputArtifacts

List<InputArtifact> inputArtifacts

The name or ID of the artifact consumed by the action, such as a test or build artifact.

name

String name

The action declaration's name.

outputArtifacts

List<OutputArtifact> outputArtifacts

The name or ID of the result of the action declaration, 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.

runOrder

Integer runOrder

The order in which actions are run.

Class com.amazonaws.services.codepipeline.model.ActionExecution

class ActionExecution extends Object implements Serializable

Serialized Fields

errorDetails

ErrorDetails errorDetails

The details of an error returned by a URL external to AWS.

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.

lastStatusChange

Date lastStatusChange

The last status change of the action.

percentComplete

Integer percentComplete

A percentage of completeness of the action as it runs.

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.

Exception Class com.amazonaws.services.codepipeline.model.ActionNotFoundException

class ActionNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codepipeline.model.ActionRevision

class ActionRevision extends Object implements Serializable

Serialized Fields

created

Date created

The date and time when the most recent version of the action was created, in timestamp format.

revisionChangeId

String revisionChangeId

The unique identifier of the change that set the state to this revision, for example a deployment ID or timestamp.

revisionId

String revisionId

The system-generated unique ID that identifies the revision number of the action.

Class com.amazonaws.services.codepipeline.model.ActionState

class ActionState extends Object implements Serializable

Serialized Fields

actionName

String actionName

The name of the action.

currentRevision

ActionRevision currentRevision

entityUrl

String entityUrl

A URL link for more information about the state of the action, such as a deployment group details page.

latestExecution

ActionExecution latestExecution

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

class ActionType extends Object implements Serializable

Serialized Fields

actionConfigurationProperties

List<ActionConfigurationProperty> actionConfigurationProperties

The configuration properties for the action type.

id

ActionTypeId id

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.

settings

ActionTypeSettings settings

The settings for the action type.

Class com.amazonaws.services.codepipeline.model.ActionTypeId

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

Exception Class com.amazonaws.services.codepipeline.model.ActionTypeNotFoundException

class ActionTypeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codepipeline.model.ActionTypeSettings

class ActionTypeSettings extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.codepipeline.model.Artifact

class Artifact extends Object implements Serializable

Serialized Fields

location

ArtifactLocation location

The location of an artifact.

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

Class com.amazonaws.services.codepipeline.model.ArtifactDetails

class ArtifactDetails extends Object implements Serializable

Serialized Fields

maximumCount

Integer maximumCount

The maximum number of artifacts allowed for the action type.

minimumCount

Integer minimumCount

The minimum number of artifacts allowed for the action type.

Class com.amazonaws.services.codepipeline.model.ArtifactLocation

class ArtifactLocation extends Object implements Serializable

Serialized Fields

s3Location

S3ArtifactLocation s3Location

The Amazon S3 bucket that contains the artifact.

type

String type

The type of artifact in the location.

Class com.amazonaws.services.codepipeline.model.ArtifactStore

class ArtifactStore extends Object implements Serializable

Serialized Fields

encryptionKey

EncryptionKey encryptionKey

The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.

location

String location

The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.

type

String type

The type of the artifact store, such as S3.

Class com.amazonaws.services.codepipeline.model.AWSSessionCredentials

class 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

class BlockerDeclaration extends Object implements Serializable

Serialized Fields

name

String name

Reserved for future use.

type

String type

Reserved for future use.

Class com.amazonaws.services.codepipeline.model.CreateCustomActionTypeRequest

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

Although Source is listed as a valid value, it is not currently functional. This value is reserved for future use.

configurationProperties

List<ActionConfigurationProperty> configurationProperties

The configuration properties for the custom action.

You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see Create a Custom Action for a Pipeline.

inputArtifactDetails

ArtifactDetails inputArtifactDetails

outputArtifactDetails

ArtifactDetails outputArtifactDetails

provider

String provider

The provider of the service used in the custom action, such as AWS CodeDeploy.

settings

ActionTypeSettings settings

version

String version

The version number of the custom action.

Class com.amazonaws.services.codepipeline.model.CreateCustomActionTypeResult

class CreateCustomActionTypeResult extends Object implements Serializable

Serialized Fields

actionType

ActionType actionType

Class com.amazonaws.services.codepipeline.model.CreatePipelineRequest

class CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipeline

PipelineDeclaration pipeline

Class com.amazonaws.services.codepipeline.model.CreatePipelineResult

class CreatePipelineResult extends Object implements Serializable

Serialized Fields

pipeline

PipelineDeclaration pipeline

Class com.amazonaws.services.codepipeline.model.CurrentRevision

class CurrentRevision extends Object implements Serializable

Serialized Fields

changeIdentifier

String changeIdentifier

The change identifier for the current revision.

revision

String revision

The revision ID of the current version of an artifact.

Class com.amazonaws.services.codepipeline.model.DeleteCustomActionTypeRequest

class 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.DeleteCustomActionTypeResult

class DeleteCustomActionTypeResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.DeletePipelineRequest

class DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the pipeline to be deleted.

Class com.amazonaws.services.codepipeline.model.DeletePipelineResult

class DeletePipelineResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.DisableStageTransitionRequest

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

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.

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

Class com.amazonaws.services.codepipeline.model.DisableStageTransitionResult

class DisableStageTransitionResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.EnableStageTransitionRequest

class 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.EnableStageTransitionResult

class EnableStageTransitionResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.EncryptionKey

class EncryptionKey extends Object implements Serializable

Serialized Fields

id

String id

The ID used to identify the key. For an AWS KMS key, this is the key ID or key ARN.

type

String type

The type of encryption key, such as an AWS Key Management Service (AWS KMS) key. When creating or updating a pipeline, the value must be set to 'KMS'.

Class com.amazonaws.services.codepipeline.model.ErrorDetails

class 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

class ExecutionDetails extends Object implements Serializable

Serialized Fields

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.

summary

String summary

The summary of the current status of the actions.

Class com.amazonaws.services.codepipeline.model.FailureDetails

class FailureDetails extends Object implements Serializable

Serialized Fields

externalExecutionId

String externalExecutionId

The external ID of the run of the action that failed.

message

String message

The message about the failure.

type

String type

The type of the failure.

Class com.amazonaws.services.codepipeline.model.GetJobDetailsRequest

class 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

class 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

class 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

class GetPipelineResult extends Object implements Serializable

Serialized Fields

pipeline

PipelineDeclaration pipeline

Class com.amazonaws.services.codepipeline.model.GetPipelineStateRequest

class 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

class GetPipelineStateResult extends Object implements Serializable

Serialized Fields

created

Date created

The date and time the pipeline was created, in timestamp format.

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

updated

Date updated

The date and time the pipeline was last updated, in timestamp format.

Class com.amazonaws.services.codepipeline.model.GetThirdPartyJobDetailsRequest

class GetThirdPartyJobDetailsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

jobId

String jobId

The unique system-generated ID used for identifying the job.

Class com.amazonaws.services.codepipeline.model.GetThirdPartyJobDetailsResult

class 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

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

Exception Class com.amazonaws.services.codepipeline.model.InvalidActionDeclarationException

class InvalidActionDeclarationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidBlockerDeclarationException

class InvalidBlockerDeclarationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidClientTokenException

class InvalidClientTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidJobException

class InvalidJobException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidJobStateException

class InvalidJobStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidNonceException

class InvalidNonceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidStageDeclarationException

class InvalidStageDeclarationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.InvalidStructureException

class InvalidStructureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codepipeline.model.Job

class Job extends Object implements Serializable

Serialized Fields

accountId

String accountId

The ID of the AWS account to use when performing the job.

data

JobData data

Additional data about a job.

id

String id

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.

Class com.amazonaws.services.codepipeline.model.JobData

class JobData extends Object implements Serializable

Serialized Fields

actionConfiguration

ActionConfiguration actionConfiguration

actionTypeId

ActionTypeId actionTypeId

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

inputArtifacts

List<Artifact> inputArtifacts

The artifact supplied to the job.

outputArtifacts

List<Artifact> outputArtifacts

The output of the job.

pipelineContext

PipelineContext pipelineContext

Class com.amazonaws.services.codepipeline.model.JobDetails

class JobDetails extends Object implements Serializable

Serialized Fields

accountId

String accountId

The AWS account ID associated with the job.

data

JobData data

id

String id

The unique system-generated ID of the job.

Exception Class com.amazonaws.services.codepipeline.model.JobNotFoundException

class JobNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codepipeline.model.ListActionTypesRequest

class 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

class ListActionTypesResult extends Object implements Serializable

Serialized Fields

actionTypes

List<ActionType> 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

class 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

class ListPipelinesResult extends Object implements Serializable

Serialized Fields

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.

pipelines

List<PipelineSummary> pipelines

The list of pipelines.

Class com.amazonaws.services.codepipeline.model.OutputArtifact

class 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

class PipelineContext extends Object implements Serializable

Serialized Fields

action

ActionContext action

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.

Class com.amazonaws.services.codepipeline.model.PipelineDeclaration

class PipelineDeclaration extends Object implements Serializable

Serialized Fields

artifactStore

ArtifactStore artifactStore

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.

stages

List<StageDeclaration> 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.

Exception Class com.amazonaws.services.codepipeline.model.PipelineNameInUseException

class PipelineNameInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.codepipeline.model.PipelineNotFoundException

class PipelineNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codepipeline.model.PipelineSummary

class PipelineSummary extends Object implements Serializable

Serialized Fields

created

Date created

The date and time the pipeline was created, in timestamp format.

name

String name

The name of the pipeline.

updated

Date updated

The date and time of the last update to the pipeline, in timestamp format.

version

Integer version

The version number of the pipeline.

Exception Class com.amazonaws.services.codepipeline.model.PipelineVersionNotFoundException

class PipelineVersionNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codepipeline.model.PollForJobsRequest

class 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<String,String> 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

class PollForJobsResult extends Object implements Serializable

Serialized Fields

jobs

List<Job> jobs

Information about the jobs to take action on.

Class com.amazonaws.services.codepipeline.model.PollForThirdPartyJobsRequest

class 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

class PollForThirdPartyJobsResult extends Object implements Serializable

Serialized Fields

jobs

List<ThirdPartyJob> jobs

Information about the jobs to take action on.

Class com.amazonaws.services.codepipeline.model.PutActionRevisionRequest

class PutActionRevisionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionName

String actionName

The name of the action that will process the revision.

actionRevision

ActionRevision actionRevision

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.

Class com.amazonaws.services.codepipeline.model.PutActionRevisionResult

class 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

class PutJobFailureResultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

failureDetails

FailureDetails failureDetails

The details about the failure of a job.

jobId

String jobId

The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

Class com.amazonaws.services.codepipeline.model.PutJobFailureResultResult

class PutJobFailureResultResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.PutJobSuccessResultRequest

class PutJobSuccessResultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

continuationToken

String continuationToken

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

currentRevision

CurrentRevision currentRevision

The ID of the current revision of the artifact successfully worked upon by the job.

executionDetails

ExecutionDetails executionDetails

The execution details of the successful job, such as the actions taken by the job worker.

jobId

String jobId

The unique system-generated ID of the job that succeeded. This is the same ID returned from PollForJobs.

Class com.amazonaws.services.codepipeline.model.PutJobSuccessResultResult

class PutJobSuccessResultResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobFailureResultRequest

class PutThirdPartyJobFailureResultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

jobId

String jobId

The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobFailureResultResult

class PutThirdPartyJobFailureResultResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobSuccessResultRequest

class PutThirdPartyJobSuccessResultRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

continuationToken

String continuationToken

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.

currentRevision

CurrentRevision currentRevision

executionDetails

ExecutionDetails executionDetails

jobId

String jobId

The ID of the job that successfully completed. This is the same ID returned from PollForThirdPartyJobs.

Class com.amazonaws.services.codepipeline.model.PutThirdPartyJobSuccessResultResult

class PutThirdPartyJobSuccessResultResult extends Object implements Serializable

Class com.amazonaws.services.codepipeline.model.S3ArtifactLocation

class 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

class StageContext extends Object implements Serializable

Serialized Fields

name

String name

The name of the stage.

Class com.amazonaws.services.codepipeline.model.StageDeclaration

class StageDeclaration extends Object implements Serializable

Serialized Fields

actions

List<ActionDeclaration> actions

The actions included in a stage.

blockers

List<BlockerDeclaration> blockers

Reserved for future use.

name

String name

The name of the stage.

Exception Class com.amazonaws.services.codepipeline.model.StageNotFoundException

class StageNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.codepipeline.model.StageState

class StageState extends Object implements Serializable

Serialized Fields

actionStates

List<ActionState> actionStates

The state of the stage.

inboundTransitionState

TransitionState inboundTransitionState

The state of the inbound transition, which is either enabled or disabled.

stageName

String stageName

The name of the stage.

Class com.amazonaws.services.codepipeline.model.StartPipelineExecutionRequest

class StartPipelineExecutionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the pipeline to start.

Class com.amazonaws.services.codepipeline.model.StartPipelineExecutionResult

class 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

class 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

class ThirdPartyJobData extends Object implements Serializable

Serialized Fields

actionConfiguration

ActionConfiguration actionConfiguration

actionTypeId

ActionTypeId actionTypeId

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

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

inputArtifacts

List<Artifact> 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<Artifact> 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.

pipelineContext

PipelineContext pipelineContext

Class com.amazonaws.services.codepipeline.model.ThirdPartyJobDetails

class ThirdPartyJobDetails extends Object implements Serializable

Serialized Fields

data

ThirdPartyJobData data

The data to be returned by the third party job worker.

id

String id

The identifier used to identify the job details in AWS CodePipeline.

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

class TransitionState extends Object implements Serializable

Serialized Fields

disabledReason

String disabledReason

The user-specified reason why the transition between two stages of a pipeline was disabled.

enabled

Boolean enabled

Whether the transition between stages is enabled (true) or disabled (false).

lastChangedAt

Date lastChangedAt

The timestamp when the transition state was last changed.

lastChangedBy

String lastChangedBy

The ID of the user who last changed the transition state.

Class com.amazonaws.services.codepipeline.model.UpdatePipelineRequest

class 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

class UpdatePipelineResult extends Object implements Serializable

Serialized Fields

pipeline

PipelineDeclaration pipeline

The structure of the updated pipeline.

Exception Class com.amazonaws.services.codepipeline.model.ValidationException

class ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.cognitoidentity.model

Class com.amazonaws.services.cognitoidentity.model.CognitoIdentityProvider

class CognitoIdentityProvider extends Object implements Serializable

Serialized Fields

clientId

String clientId

The client ID for the Cognito User Identity Pool.

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.

Exception Class com.amazonaws.services.cognitoidentity.model.ConcurrentModificationException

class ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolRequest

class CreateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allowUnauthenticatedIdentities

Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing a Cognito User Identity Pool and its client ID.

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.

identityPoolName

String identityPoolName

A string that you provide.

openIdConnectProviderARNs

List<String> openIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

supportedLoginProviders

Map<String,String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.CreateIdentityPoolResult

class CreateIdentityPoolResult extends Object implements Serializable

Serialized Fields

allowUnauthenticatedIdentities

Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing a Cognito User Identity Pool and its client ID.

developerProviderName

String developerProviderName

The "domain" by which Cognito will refer to your users.

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

identityPoolName

String identityPoolName

A string that you provide.

openIdConnectProviderARNs

List<String> openIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

supportedLoginProviders

Map<String,String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.Credentials

class Credentials extends Object implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

The Access Key portion of the credentials.

expiration

Date expiration

The date at which these credentials will expire.

secretKey

String secretKey

The Secret Access Key portion of the credentials

sessionToken

String sessionToken

The Session Token portion of the credentials

Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesRequest

class DeleteIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityIdsToDelete

List<String> identityIdsToDelete

A list of 1-60 identities that you want to delete.

Class com.amazonaws.services.cognitoidentity.model.DeleteIdentitiesResult

class DeleteIdentitiesResult extends Object implements Serializable

Serialized Fields

unprocessedIdentityIds

List<UnprocessedIdentityId> unprocessedIdentityIds

An array of UnprocessedIdentityId objects, each of which contains an ErrorCode and IdentityId.

Class com.amazonaws.services.cognitoidentity.model.DeleteIdentityPoolRequest

class 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.DeleteIdentityPoolResult

class DeleteIdentityPoolResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityPoolRequest

class 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

class DescribeIdentityPoolResult extends Object implements Serializable

Serialized Fields

allowUnauthenticatedIdentities

Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing a Cognito User Identity Pool and its client ID.

developerProviderName

String developerProviderName

The "domain" by which Cognito will refer to your users.

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

identityPoolName

String identityPoolName

A string that you provide.

openIdConnectProviderARNs

List<String> openIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

supportedLoginProviders

Map<String,String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.DescribeIdentityRequest

class 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

class DescribeIdentityResult extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

Date on which the identity was created.

identityId

String identityId

A unique identifier in the format REGION:GUID.

lastModifiedDate

Date lastModifiedDate

Date on which the identity was last modified.

logins

List<String> logins

A set of optional name-value pairs that map provider names to provider tokens.

Exception Class com.amazonaws.services.cognitoidentity.model.DeveloperUserAlreadyRegisteredException

class DeveloperUserAlreadyRegisteredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidentity.model.ExternalServiceException

class ExternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityRequest

class GetCredentialsForIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

String identityId

A unique identifier in the format REGION:GUID.

logins

Map<String,String> logins

A set of optional name-value pairs that map provider names to provider tokens.

Class com.amazonaws.services.cognitoidentity.model.GetCredentialsForIdentityResult

class GetCredentialsForIdentityResult extends Object implements Serializable

Serialized Fields

credentials

Credentials credentials

Credentials for the provided identity ID.

identityId

String identityId

A unique identifier in the format REGION:GUID.

Class com.amazonaws.services.cognitoidentity.model.GetIdentityPoolRolesRequest

class 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

class GetIdentityPoolRolesResult extends Object implements Serializable

Serialized Fields

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

roles

Map<String,String> roles

The map of roles associated with this pool. Currently only authenticated and unauthenticated roles are supported.

Class com.amazonaws.services.cognitoidentity.model.GetIdRequest

class 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<String,String> 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

class 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

class GetOpenIdTokenForDeveloperIdentityRequest 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.

logins

Map<String,String> 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

class 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

class GetOpenIdTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

String identityId

A unique identifier in the format REGION:GUID.

logins

Map<String,String> 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

class 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

class IdentityDescription extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

Date on which the identity was created.

identityId

String identityId

A unique identifier in the format REGION:GUID.

lastModifiedDate

Date lastModifiedDate

Date on which the identity was last modified.

logins

List<String> logins

A set of optional name-value pairs that map provider names to provider tokens.

Class com.amazonaws.services.cognitoidentity.model.IdentityPoolShortDescription

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

Exception Class com.amazonaws.services.cognitoidentity.model.InternalErrorException

class InternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidentity.model.InvalidIdentityPoolConfigurationException

class InvalidIdentityPoolConfigurationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidentity.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidentity.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesRequest

class ListIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.cognitoidentity.model.ListIdentitiesResult

class ListIdentitiesResult extends Object implements Serializable

Serialized Fields

identities

List<IdentityDescription> identities

An object containing a set of identities and associated mappings.

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

nextToken

String nextToken

A pagination token.

Class com.amazonaws.services.cognitoidentity.model.ListIdentityPoolsRequest

class 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

class ListIdentityPoolsResult extends Object implements Serializable

Serialized Fields

identityPools

List<IdentityPoolShortDescription> identityPools

The identity pools returned by the ListIdentityPools action.

nextToken

String nextToken

A pagination token.

Class com.amazonaws.services.cognitoidentity.model.LookupDeveloperIdentityRequest

class LookupDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

identityId

String identityId

A unique identifier in the format REGION:GUID.

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

class LookupDeveloperIdentityResult extends Object implements Serializable

Serialized Fields

developerUserIdentifierList

List<String> 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.

identityId

String identityId

A unique identifier in the format REGION:GUID.

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

class MergeDeveloperIdentitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

sourceUserIdentifier

String sourceUserIdentifier

User identifier for the source user. The value should be a DeveloperUserIdentifier.

Class com.amazonaws.services.cognitoidentity.model.MergeDeveloperIdentitiesResult

class MergeDeveloperIdentitiesResult extends Object implements Serializable

Serialized Fields

identityId

String identityId

A unique identifier in the format REGION:GUID.

Exception Class com.amazonaws.services.cognitoidentity.model.NotAuthorizedException

class NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidentity.model.ResourceConflictException

class ResourceConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidentity.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.SetIdentityPoolRolesRequest

class SetIdentityPoolRolesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

roles

Map<String,String> 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.SetIdentityPoolRolesResult

class SetIdentityPoolRolesResult extends Object implements Serializable

Exception Class com.amazonaws.services.cognitoidentity.model.TooManyRequestsException

class TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidentity.model.UnlinkDeveloperIdentityRequest

class UnlinkDeveloperIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

identityId

String identityId

A unique identifier in the format REGION:GUID.

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

Class com.amazonaws.services.cognitoidentity.model.UnlinkDeveloperIdentityResult

class UnlinkDeveloperIdentityResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidentity.model.UnlinkIdentityRequest

class UnlinkIdentityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

String identityId

A unique identifier in the format REGION:GUID.

logins

Map<String,String> logins

A set of optional name-value pairs that map provider names to provider tokens.

loginsToRemove

List<String> loginsToRemove

Provider names to unlink from this identity.

Class com.amazonaws.services.cognitoidentity.model.UnlinkIdentityResult

class UnlinkIdentityResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidentity.model.UnprocessedIdentityId

class UnprocessedIdentityId extends Object implements Serializable

Serialized Fields

errorCode

String errorCode

The error code indicating the type of error that occurred.

identityId

String identityId

A unique identifier in the format REGION:GUID.

Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolRequest

class UpdateIdentityPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allowUnauthenticatedIdentities

Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing a Cognito User Identity Pool and its client ID.

developerProviderName

String developerProviderName

The "domain" by which Cognito will refer to your users.

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

identityPoolName

String identityPoolName

A string that you provide.

openIdConnectProviderARNs

List<String> openIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

supportedLoginProviders

Map<String,String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Class com.amazonaws.services.cognitoidentity.model.UpdateIdentityPoolResult

class UpdateIdentityPoolResult extends Object implements Serializable

Serialized Fields

allowUnauthenticatedIdentities

Boolean allowUnauthenticatedIdentities

TRUE if the identity pool supports unauthenticated logins.

cognitoIdentityProviders

List<CognitoIdentityProvider> cognitoIdentityProviders

A list representing a Cognito User Identity Pool and its client ID.

developerProviderName

String developerProviderName

The "domain" by which Cognito will refer to your users.

identityPoolId

String identityPoolId

An identity pool ID in the format REGION:GUID.

identityPoolName

String identityPoolName

A string that you provide.

openIdConnectProviderARNs

List<String> openIdConnectProviderARNs

A list of OpendID Connect provider ARNs.

supportedLoginProviders

Map<String,String> supportedLoginProviders

Optional key:value pairs mapping provider names to provider app IDs.

Package com.amazonaws.services.cognitoidp.model

Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesRequest

class AddCustomAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customAttributes

List<SchemaAttributeType> customAttributes

An array of custom attributes, such as Mutable and Name.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to add custom attributes.

Class com.amazonaws.services.cognitoidp.model.AddCustomAttributesResult

class AddCustomAttributesResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpRequest

class AdminConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

String username

The user name for which you want to confirm user registration.

userPoolId

String userPoolId

The user pool ID for which you want to confirm user registration.

Class com.amazonaws.services.cognitoidp.model.AdminConfirmSignUpResult

class AdminConfirmSignUpResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesRequest

class AdminDeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userAttributeNames

List<String> userAttributeNames

An array of strings representing the user attribute names you wish to delete.

username

String username

The user name of the user from which you would like to delete attributes.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to delete user attributes.

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserAttributesResult

class AdminDeleteUserAttributesResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserRequest

class AdminDeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

String username

The user name of the user you wish to delete.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to delete the user.

Class com.amazonaws.services.cognitoidp.model.AdminDeleteUserResult

class AdminDeleteUserResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminDisableUserRequest

class AdminDisableUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

String username

The user name of the user you wish to disable.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to disable the user.

Class com.amazonaws.services.cognitoidp.model.AdminDisableUserResult

class AdminDisableUserResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminEnableUserRequest

class AdminEnableUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

String username

The user name of the user you wish to ebable.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to enable the user.

Class com.amazonaws.services.cognitoidp.model.AdminEnableUserResult

class AdminEnableUserResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminGetUserRequest

class AdminGetUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

String username

The user name of the user you wish to retrieve.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to get information about the user.

Class com.amazonaws.services.cognitoidp.model.AdminGetUserResult

class AdminGetUserResult extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Indicates that the status is enabled.

mFAOptions

List<MFAOptionType> mFAOptions

Specifies the options for MFA (e.g., email or phone number).

userAttributes

List<AttributeType> 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.

username

String username

The user name of the user about whom you are receiving information.

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

class AdminResetUserPasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

username

String username

The user name of the user whose password you wish to reset.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to reset the user's password.

Class com.amazonaws.services.cognitoidp.model.AdminResetUserPasswordResult

class AdminResetUserPasswordResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest

class AdminSetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mFAOptions

List<MFAOptionType> mFAOptions

Specifies the options for MFA (e.g., email or phone number).

username

String username

The user name of the user for whom you wish to set user settings.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to set the user's settings, such as MFA options.

Class com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsResult

class AdminSetUserSettingsResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesRequest

class AdminUpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userAttributes

List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

username

String username

The user name of the user for whom you want to update user attributes.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to update user attributes.

Class com.amazonaws.services.cognitoidp.model.AdminUpdateUserAttributesResult

class AdminUpdateUserAttributesResult extends Object implements Serializable

Exception Class com.amazonaws.services.cognitoidp.model.AliasExistsException

class AliasExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.AttributeType

class 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

class ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

String accessToken

The access token in the change password request.

previousPassword

String previousPassword

The old password in the change password request.

proposedPassword

String proposedPassword

The new password in the change password request.

Class com.amazonaws.services.cognitoidp.model.ChangePasswordResult

class ChangePasswordResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.CodeDeliveryDetailsType

class CodeDeliveryDetailsType extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

The name of the attribute in the code delivery details type.

deliveryMedium

String deliveryMedium

The delivery medium (email message or phone number).

destination

String destination

The destination for the code delivery details.

Exception Class com.amazonaws.services.cognitoidp.model.CodeMismatchException

class CodeMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidp.model.ConcurrentModificationException

class ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.ConfirmForgotPasswordRequest

class ConfirmForgotPasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

String clientId

The ID of the client associated with the user pool.

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.

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

class ConfirmForgotPasswordResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpRequest

class ConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

String clientId

The ID of the client associated with the user pool.

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.

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.

Class com.amazonaws.services.cognitoidp.model.ConfirmSignUpResult

class ConfirmSignUpResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientRequest

class CreateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to create a user pool client.

Class com.amazonaws.services.cognitoidp.model.CreateUserPoolClientResult

class 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

class CreateUserPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasAttributes

List<String> aliasAttributes

Attributes supported as an alias for this user pool. Possible values: phone_number, email, or preferred_username.

autoVerifiedAttributes

List<String> autoVerifiedAttributes

The attributes to be auto-verified. Possible values: email, phone_number.

emailVerificationMessage

String emailVerificationMessage

A string representing the email verification message.

emailVerificationSubject

String emailVerificationSubject

A string representing the email verification subject.

lambdaConfig

LambdaConfigType lambdaConfig

The Lambda trigger configuration information for the new user pool.

mfaConfiguration

String mfaConfiguration

Specifies MFA configuration details.

policies

UserPoolPolicyType policies

The policies associated with the new user pool.

poolName

String poolName

A string used to name the user pool.

smsAuthenticationMessage

String smsAuthenticationMessage

A string representing the SMS authentication message.

smsVerificationMessage

String smsVerificationMessage

A string representing the SMS verification message.

Class com.amazonaws.services.cognitoidp.model.CreateUserPoolResult

class CreateUserPoolResult extends Object implements Serializable

Serialized Fields

userPool

UserPoolType userPool

A container for the user pool details.

Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesRequest

class DeleteUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

String accessToken

The access token used in the request to delete user attributes.

userAttributeNames

List<String> userAttributeNames

An array of strings representing the user attribute names you wish to delete.

Class com.amazonaws.services.cognitoidp.model.DeleteUserAttributesResult

class DeleteUserAttributesResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolClientRequest

class DeleteUserPoolClientRequest extends AmazonWebServiceRequest 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 delete the client.

Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolClientResult

class DeleteUserPoolClientResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.DeleteUserPoolRequest

class 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.DeleteUserPoolResult

class DeleteUserPoolResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.DeleteUserRequest

class 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.DeleteUserResult

class DeleteUserResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientRequest

class DescribeUserPoolClientRequest extends AmazonWebServiceRequest 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 you want to describe.

Class com.amazonaws.services.cognitoidp.model.DescribeUserPoolClientResult

class 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

class 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

class DescribeUserPoolResult extends Object implements Serializable

Serialized Fields

userPool

UserPoolType userPool

The container of metadata returned by the server to describe the pool.

Exception Class com.amazonaws.services.cognitoidp.model.ExpiredCodeException

class ExpiredCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.ForgotPasswordRequest

class 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

class ForgotPasswordResult extends Object implements Serializable

Serialized Fields

codeDeliveryDetails

CodeDeliveryDetailsType codeDeliveryDetails

Class com.amazonaws.services.cognitoidp.model.GetUserAttributeVerificationCodeRequest

class 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

class 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

class 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

class GetUserResult extends Object implements Serializable

Serialized Fields

mFAOptions

List<MFAOptionType> mFAOptions

Specifies the options for MFA (e.g., email or phone number).

userAttributes

List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

username

String username

The user name of the user you wish to retrieve from the get user request.

Exception Class com.amazonaws.services.cognitoidp.model.InternalErrorException

class InternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidp.model.InvalidLambdaResponseException

class InvalidLambdaResponseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidp.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidp.model.InvalidPasswordException

class InvalidPasswordException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.LambdaConfigType

class LambdaConfigType extends Object implements Serializable

Serialized Fields

customMessage

String customMessage

A custom Message AWS Lambda trigger.

postAuthentication

String postAuthentication

A post-authentication AWS Lambda trigger.

postConfirmation

String postConfirmation

A post-confirmation AWS Lambda trigger.

preAuthentication

String preAuthentication

A pre-authentication AWS Lambda trigger.

preSignUp

String preSignUp

A pre-registration AWS Lambda trigger.

Exception Class com.amazonaws.services.cognitoidp.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.ListUserPoolClientsRequest

class ListUserPoolClientsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to list user pool clients.

Class com.amazonaws.services.cognitoidp.model.ListUserPoolClientsResult

class ListUserPoolClientsResult extends Object 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.

userPoolClients

List<UserPoolClientDescription> userPoolClients

The user pool clients in the response that lists user pool clients.

Class com.amazonaws.services.cognitoidp.model.ListUserPoolsRequest

class ListUserPoolsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

The maximum number of results you want the request to return when listing the user pools.

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

class ListUserPoolsResult extends Object 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.

userPools

List<UserPoolDescriptionType> userPools

The user pools from the response to list users.

Class com.amazonaws.services.cognitoidp.model.ListUsersRequest

class ListUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

List<String> 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.

userPoolId

String userPoolId

The user pool ID for which you want to list users.

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

class ListUsersResult extends Object implements Serializable

Serialized Fields

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.

users

List<UserType> users

The users returned in the request to list users.

Class com.amazonaws.services.cognitoidp.model.MFAOptionType

class MFAOptionType extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

The attribute name of the MFA option type.

deliveryMedium

String deliveryMedium

The delivery medium (email message or SMS message) to send the MFA code.

Exception Class com.amazonaws.services.cognitoidp.model.NotAuthorizedException

class NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.NumberAttributeConstraintsType

class NumberAttributeConstraintsType extends Object implements Serializable

Serialized Fields

maxValue

String maxValue

The maximum value of an attribute that is of the number data type.

minValue

String minValue

The minimum value of an attribute that is of the number data type.

Class com.amazonaws.services.cognitoidp.model.PasswordPolicyType

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

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.

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.

Class com.amazonaws.services.cognitoidp.model.ResendConfirmationCodeRequest

class 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

class ResendConfirmationCodeResult extends Object implements Serializable

Serialized Fields

codeDeliveryDetails

CodeDeliveryDetailsType codeDeliveryDetails

Exception Class com.amazonaws.services.cognitoidp.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.SchemaAttributeType

class SchemaAttributeType extends Object implements Serializable

Serialized Fields

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.

name

String name

A schema attribute of the name type.

numberAttributeConstraints

NumberAttributeConstraintsType numberAttributeConstraints

Specifies the constraints for an attribute of the number type.

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.

stringAttributeConstraints

StringAttributeConstraintsType stringAttributeConstraints

Specifies the constraints for an attribute of the string type.

Class com.amazonaws.services.cognitoidp.model.SetUserSettingsRequest

class SetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

String accessToken

The access token for the set user settings request.

mFAOptions

List<MFAOptionType> mFAOptions

Specifies the options for MFA (e.g., email or phone number).

Class com.amazonaws.services.cognitoidp.model.SetUserSettingsResult

class SetUserSettingsResult extends Object implements Serializable

Class com.amazonaws.services.cognitoidp.model.SignUpRequest

class SignUpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

String clientId

The ID of the client associated with the user pool.

password

String password

The password of the user you wish to register.

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.

userAttributes

List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

username

String username

The user name of the user you wish to register.

validationData

List<AttributeType> validationData

The validation data in the request to register a user.

Class com.amazonaws.services.cognitoidp.model.SignUpResult

class SignUpResult extends Object implements Serializable

Serialized Fields

codeDeliveryDetails

CodeDeliveryDetailsType codeDeliveryDetails

userConfirmed

Boolean userConfirmed

A response from the server indicating that a user registration has been confirmed.

Class com.amazonaws.services.cognitoidp.model.StringAttributeConstraintsType

class StringAttributeConstraintsType extends Object implements Serializable

Serialized Fields

maxLength

String maxLength

The maximum length of an attribute value of the string type.

minLength

String minLength

The minimum length of an attribute value of the string type.

Exception Class com.amazonaws.services.cognitoidp.model.TooManyFailedAttemptsException

class TooManyFailedAttemptsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidp.model.TooManyRequestsException

class TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidp.model.UnexpectedLambdaException

class UnexpectedLambdaException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.UpdateUserAttributesRequest

class UpdateUserAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessToken

String accessToken

The access token for the request to update user attributes.

userAttributes

List<AttributeType> userAttributes

An array of name-value pairs representing user attributes.

Class com.amazonaws.services.cognitoidp.model.UpdateUserAttributesResult

class UpdateUserAttributesResult extends Object implements Serializable

Serialized Fields

codeDeliveryDetailsList

List<CodeDeliveryDetailsType> codeDeliveryDetailsList

The code delivery details list from the server for the request to update user attributes.

Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolClientRequest

class UpdateUserPoolClientRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to update the user pool client.

Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolClientResult

class 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

class UpdateUserPoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoVerifiedAttributes

List<String> autoVerifiedAttributes

The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.

emailVerificationMessage

String emailVerificationMessage

The contents of the email verification message.

emailVerificationSubject

String emailVerificationSubject

The subject of the email verfication message

lambdaConfig

LambdaConfigType lambdaConfig

The AWS Lambda configuration information from the request to update the user pool.

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.

policies

UserPoolPolicyType policies

A container with the policies you wish to update in a user pool.

smsAuthenticationMessage

String smsAuthenticationMessage

The contents of the SMS authentication message.

smsVerificationMessage

String smsVerificationMessage

A container with information about the SMS verification message.

userPoolId

String userPoolId

The user pool ID for the user pool you want to update.

Class com.amazonaws.services.cognitoidp.model.UpdateUserPoolResult

class UpdateUserPoolResult extends Object implements Serializable

Exception Class com.amazonaws.services.cognitoidp.model.UserLambdaValidationException

class UserLambdaValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitoidp.model.UsernameExistsException

class UsernameExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitoidp.model.UserPoolClientDescription

class UserPoolClientDescription extends Object implements Serializable

Serialized Fields

clientId

String clientId

The ID of the client associated with the user pool.

clientName

String clientName

The client name from the user pool client description.

userPoolId

String userPoolId

The user pool ID for the user pool where you want to describe the user pool client.

Class com.amazonaws.services.cognitoidp.model.UserPoolClientType

class UserPoolClientType extends Object implements Serializable

Serialized Fields

clientId

String clientId

The ID of the client associated with the user pool.

clientName

String clientName

The client name from the user pool request of the client type.

clientSecret

String clientSecret

The client secret from the user pool request of the client type.

creationDate

Date creationDate

The creation date 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.

userPoolId

String userPoolId

The user pool ID for the user pool client.

Class com.amazonaws.services.cognitoidp.model.UserPoolDescriptionType

class UserPoolDescriptionType extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

The creation date in a user pool description.

id

String id

The ID in a user pool description.

lambdaConfig

LambdaConfigType lambdaConfig

The AWS Lambda configuration information in a user pool description.

lastModifiedDate

Date lastModifiedDate

The last modified date in a user pool description.

name

String name

The name in a user pool description.

status

String status

The user pool status in a user pool description.

Class com.amazonaws.services.cognitoidp.model.UserPoolPolicyType

class 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

class UserPoolType extends Object implements Serializable

Serialized Fields

aliasAttributes

List<String> aliasAttributes

Specifies the attributes that are aliased in a user pool.

autoVerifiedAttributes

List<String> autoVerifiedAttributes

Specifies the attributes that are auto-verified in a user pool.

creationDate

Date creationDate

The creation date of a user pool.

emailVerificationMessage

String emailVerificationMessage

The contents of the email verification message.

emailVerificationSubject

String emailVerificationSubject

The subject of the email verification message.

estimatedNumberOfUsers

Integer estimatedNumberOfUsers

A number estimating the size of the user pool.

id

String id

The ID of the user pool.

lambdaConfig

LambdaConfigType lambdaConfig

A container describing the AWS Lambda triggers associated with a user pool.

lastModifiedDate

Date lastModifiedDate

The last modified date of a user pool.

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.

name

String name

The name of the user pool.

policies

UserPoolPolicyType policies

A container describing the policies associated with a user pool.

schemaAttributes

List<SchemaAttributeType> schemaAttributes

A container with the schema attributes of a user pool.

smsAuthenticationMessage

String smsAuthenticationMessage

The contents of the SMS authentication message.

smsVerificationMessage

String smsVerificationMessage

The contents of the SMS verification message.

status

String status

The status of a user pool.

Class com.amazonaws.services.cognitoidp.model.UserType

class UserType extends Object implements Serializable

Serialized Fields

attributes

List<AttributeType> attributes

A container with information about the user type attributes.

enabled

Boolean enabled

Specifies whether the user is enabled.

userCreateDate

Date userCreateDate

The creation date of the user.

userLastModifiedDate

Date userLastModifiedDate

The last modified date of the user.

username

String username

The user name of the user you wish to describe.

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

class 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

class VerifyUserAttributeResult extends Object implements Serializable

Package com.amazonaws.services.cognitosync.model

Exception Class com.amazonaws.services.cognitosync.model.AlreadyStreamedException

class AlreadyStreamedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitosync.model.BulkPublishRequest

class 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

class 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

class CognitoStreams extends Object implements Serializable

Serialized Fields

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.

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.

Exception Class com.amazonaws.services.cognitosync.model.ConcurrentModificationException

class ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitosync.model.Dataset

class Dataset extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

Date on which the dataset was created.

datasetName

String datasetName

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

dataStorage

Long dataStorage

Total size in bytes of the records in this dataset.

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.

lastModifiedBy

String lastModifiedBy

The device that made the last change to this dataset.

lastModifiedDate

Date lastModifiedDate

Date when the dataset was last modified.

numRecords

Long numRecords

Number of records in this dataset.

Class com.amazonaws.services.cognitosync.model.DeleteDatasetRequest

class DeleteDatasetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetName

String datasetName

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

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.

Class com.amazonaws.services.cognitosync.model.DeleteDatasetResult

class 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

class DescribeDatasetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetName

String datasetName

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

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.

Class com.amazonaws.services.cognitosync.model.DescribeDatasetResult

class 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

class 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

class 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

class DescribeIdentityUsageRequest extends AmazonWebServiceRequest 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.

Class com.amazonaws.services.cognitosync.model.DescribeIdentityUsageResult

class DescribeIdentityUsageResult extends Object implements Serializable

Serialized Fields

identityUsage

IdentityUsage identityUsage

Usage information for the identity.

Exception Class com.amazonaws.services.cognitosync.model.DuplicateRequestException

class DuplicateRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitosync.model.GetBulkPublishDetailsRequest

class 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

class GetBulkPublishDetailsResult extends Object implements Serializable

Serialized Fields

bulkPublishCompleteTime

Date bulkPublishCompleteTime

If BulkPublishStatus is SUCCEEDED, the time the last bulk publish operation completed.

bulkPublishStartTime

Date bulkPublishStartTime

The date/time at which the last bulk publish was initiated.

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.

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

class 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

class GetCognitoEventsResult extends Object implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalMap<String,String> events

The Cognito Events returned from the GetCognitoEvents request

Class com.amazonaws.services.cognitosync.model.GetIdentityPoolConfigurationRequest

class 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

class GetIdentityPoolConfigurationResult extends Object implements Serializable

Serialized Fields

cognitoStreams

CognitoStreams cognitoStreams

Options to apply to this identity pool for Amazon Cognito streams.

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.

Class com.amazonaws.services.cognitosync.model.IdentityPoolUsage

class IdentityPoolUsage extends Object implements Serializable

Serialized Fields

dataStorage

Long dataStorage

Data storage information for the identity pool.

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 pool was last modified.

syncSessionsCount

Long syncSessionsCount

Number of sync sessions for the identity pool.

Class com.amazonaws.services.cognitosync.model.IdentityUsage

class IdentityUsage extends Object implements Serializable

Serialized Fields

datasetCount

Integer datasetCount

Number of datasets for the identity.

dataStorage

Long dataStorage

Total data storage for this identity.

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.

Exception Class com.amazonaws.services.cognitosync.model.InternalErrorException

class InternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitosync.model.InvalidConfigurationException

class InvalidConfigurationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitosync.model.InvalidLambdaFunctionOutputException

class InvalidLambdaFunctionOutputException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitosync.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitosync.model.LambdaThrottledException

class LambdaThrottledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitosync.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitosync.model.ListDatasetsRequest

class ListDatasetsRequest extends AmazonWebServiceRequest 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.

maxResults

Integer maxResults

The maximum number of results to be returned.

nextToken

String nextToken

A pagination token for obtaining the next page of results.

Class com.amazonaws.services.cognitosync.model.ListDatasetsResult

class ListDatasetsResult extends Object implements Serializable

Serialized Fields

count

Integer count

Number of datasets returned.

datasets

com.amazonaws.internal.SdkInternalList<Dataset> datasets

A set of datasets.

nextToken

String nextToken

A pagination token for obtaining the next page of results.

Class com.amazonaws.services.cognitosync.model.ListIdentityPoolUsageRequest

class ListIdentityPoolUsageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

The maximum number of results to be returned.

nextToken

String nextToken

A pagination token for obtaining the next page of results.

Class com.amazonaws.services.cognitosync.model.ListIdentityPoolUsageResult

class ListIdentityPoolUsageResult extends Object implements Serializable

Serialized Fields

count

Integer count

Total number of identities for the identity pool.

identityPoolUsages

com.amazonaws.internal.SdkInternalList<IdentityPoolUsage> identityPoolUsages

Usage information for the identity pools.

maxResults

Integer maxResults

The maximum number of results to be returned.

nextToken

String nextToken

A pagination token for obtaining the next page of results.

Class com.amazonaws.services.cognitosync.model.ListRecordsRequest

class ListRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetName

String datasetName

A string of up to 128 characters. Allowed characters are a-z, A-Z, 0-9, '_' (underscore), '-' (dash), and '.' (dot).

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.

lastSyncCount

Long lastSyncCount

The last server sync count for this record.

maxResults

Integer maxResults

The maximum number of results to be returned.

nextToken

String nextToken

A pagination token for obtaining the next page of results.

syncSessionToken

String syncSessionToken

A token containing a session ID, identity ID, and expiration.

Class com.amazonaws.services.cognitosync.model.ListRecordsResult

class ListRecordsResult extends Object implements Serializable

Serialized Fields

count

Integer count

Total number of records.

datasetDeletedAfterRequestedSyncCount

Boolean datasetDeletedAfterRequestedSyncCount

A boolean value specifying whether to delete the dataset locally.

datasetExists

Boolean datasetExists

Indicates whether the dataset exists.

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<String> mergedDatasetNames

Names of merged datasets.

nextToken

String nextToken

A pagination token for obtaining the next page of results.

records

com.amazonaws.internal.SdkInternalList<Record> records

A list of all records.

syncSessionToken

String syncSessionToken

A token containing a session ID, identity ID, and expiration.

Exception Class com.amazonaws.services.cognitosync.model.NotAuthorizedException

class NotAuthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitosync.model.PushSync

class PushSync extends Object implements Serializable

Serialized Fields

applicationArns

com.amazonaws.internal.SdkInternalList<String> 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

class Record extends Object implements Serializable

Serialized Fields

deviceLastModifiedDate

Date deviceLastModifiedDate

The last modified date of the client device.

key

String key

The key for the record.

lastModifiedBy

String lastModifiedBy

The user/device that made the last change to this record.

lastModifiedDate

Date lastModifiedDate

The date on which the record was last modified.

syncCount

Long syncCount

The server sync count for this record.

value

String value

The value for the record.

Class com.amazonaws.services.cognitosync.model.RecordPatch

class RecordPatch extends Object implements Serializable

Serialized Fields

deviceLastModifiedDate

Date deviceLastModifiedDate

The last modified date of the client device.

key

String key

The key associated with the record patch.

op

String op

An operation, either replace or remove.

syncCount

Long syncCount

Last known server sync count for this record. Set to 0 if unknown.

value

String value

The value associated with the record patch.

Class com.amazonaws.services.cognitosync.model.RegisterDeviceRequest

class RegisterDeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

identityId

String identityId

The unique ID for this identity.

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.

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

class RegisterDeviceResult extends Object implements Serializable

Serialized Fields

deviceId

String deviceId

The unique ID generated for this device by Cognito.

Exception Class com.amazonaws.services.cognitosync.model.ResourceConflictException

class ResourceConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.cognitosync.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitosync.model.SetCognitoEventsRequest

class SetCognitoEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalMap<String,String> events

The events to configure

identityPoolId

String identityPoolId

The Cognito Identity Pool to use when configuring Cognito Events

Class com.amazonaws.services.cognitosync.model.SetCognitoEventsResult

class SetCognitoEventsResult extends Object implements Serializable

Class com.amazonaws.services.cognitosync.model.SetIdentityPoolConfigurationRequest

class SetIdentityPoolConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cognitoStreams

CognitoStreams cognitoStreams

Options to apply to this identity pool for Amazon Cognito streams.

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.

Class com.amazonaws.services.cognitosync.model.SetIdentityPoolConfigurationResult

class SetIdentityPoolConfigurationResult extends Object implements Serializable

Serialized Fields

cognitoStreams

CognitoStreams cognitoStreams

Options to apply to this identity pool for Amazon Cognito streams.

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.

Class com.amazonaws.services.cognitosync.model.SubscribeToDatasetRequest

class SubscribeToDatasetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetName

String datasetName

The name of the dataset to subcribe to.

deviceId

String deviceId

The unique ID generated for this device by Cognito.

identityId

String identityId

Unique ID for this identity.

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.

Class com.amazonaws.services.cognitosync.model.SubscribeToDatasetResult

class SubscribeToDatasetResult extends Object implements Serializable

Exception Class com.amazonaws.services.cognitosync.model.TooManyRequestsException

class TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.cognitosync.model.UnsubscribeFromDatasetRequest

class UnsubscribeFromDatasetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

datasetName

String datasetName

The name of the dataset from which to unsubcribe.

deviceId

String deviceId

The unique ID generated for this device by Cognito.

identityId

String identityId

Unique ID for this identity.

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.

Class com.amazonaws.services.cognitosync.model.UnsubscribeFromDatasetResult

class UnsubscribeFromDatasetResult extends Object implements Serializable

Class com.amazonaws.services.cognitosync.model.UpdateRecordsRequest

class UpdateRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

recordPatches

com.amazonaws.internal.SdkInternalList<RecordPatch> recordPatches

A list of patch operations.

syncSessionToken

String syncSessionToken

The SyncSessionToken returned by a previous call to ListRecords for this dataset and identity.

Class com.amazonaws.services.cognitosync.model.UpdateRecordsResult

class UpdateRecordsResult extends Object implements Serializable

Serialized Fields

records

com.amazonaws.internal.SdkInternalList<Record> records

A list of records that have been updated.

Package com.amazonaws.services.config.model

Class com.amazonaws.services.config.model.Compliance

class Compliance extends Object implements Serializable

Serialized Fields

complianceContributorCount

ComplianceContributorCount complianceContributorCount

The number of AWS resources or AWS Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

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.

Class com.amazonaws.services.config.model.ComplianceByConfigRule

class ComplianceByConfigRule extends Object implements Serializable

Serialized Fields

compliance

Compliance compliance

Indicates whether the AWS Config rule is compliant.

configRuleName

String configRuleName

The name of the AWS Config rule.

Class com.amazonaws.services.config.model.ComplianceByResource

class ComplianceByResource extends Object implements Serializable

Serialized Fields

compliance

Compliance compliance

Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.

resourceId

String resourceId

The ID of the AWS resource that was evaluated.

resourceType

String resourceType

The type of the AWS resource that was evaluated.

Class com.amazonaws.services.config.model.ComplianceContributorCount

class ComplianceContributorCount extends Object implements Serializable

Serialized Fields

capExceeded

Boolean capExceeded

Indicates whether the maximum count is reached.

cappedCount

Integer cappedCount

The number of AWS resources or AWS Config rules responsible for the current compliance of the item.

Class com.amazonaws.services.config.model.ComplianceSummary

class ComplianceSummary extends Object implements Serializable

Serialized Fields

complianceSummaryTimestamp

Date complianceSummaryTimestamp

The time that AWS Config created the compliance summary.

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.

Class com.amazonaws.services.config.model.ComplianceSummaryByResourceType

class ComplianceSummaryByResourceType extends Object implements Serializable

Serialized Fields

complianceSummary

ComplianceSummary complianceSummary

The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each compliance.

resourceType

String resourceType

The type of AWS resource.

Class com.amazonaws.services.config.model.ConfigExportDeliveryInfo

class ConfigExportDeliveryInfo extends Object implements Serializable

Serialized Fields

lastAttemptTime

Date lastAttemptTime

The time 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.

lastStatus

String lastStatus

Status 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

class ConfigRule extends Object implements Serializable

Serialized Fields

configRuleArn

String configRuleArn

The Amazon Resource Name (ARN) of the AWS Config rule.

configRuleId

String configRuleId

The ID of the AWS Config rule.

configRuleName

String configRuleName

The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.

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.

description

String description

The description that you provide for the AWS Config rule.

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.

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.

Class com.amazonaws.services.config.model.ConfigRuleEvaluationStatus

class ConfigRuleEvaluationStatus extends Object implements Serializable

Serialized Fields

configRuleArn

String configRuleArn

The Amazon Resource Name (ARN) of the AWS Config rule.

configRuleId

String configRuleId

The ID of the AWS Config rule.

configRuleName

String configRuleName

The name of the AWS Config rule.

firstActivatedTime

Date firstActivatedTime

The time that you first activated the AWS Config rule.

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.

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.

lastFailedEvaluationTime

Date lastFailedEvaluationTime

The time that AWS Config last failed to evaluate your AWS resources against the rule.

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.

lastSuccessfulInvocationTime

Date lastSuccessfulInvocationTime

The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.

Class com.amazonaws.services.config.model.ConfigSnapshotDeliveryProperties

class 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

class ConfigStreamDeliveryInfo extends Object implements Serializable

Serialized Fields

lastErrorCode

String lastErrorCode

The error code from the last attempted delivery.

lastErrorMessage

String lastErrorMessage

The error message from the last attempted delivery.

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.

lastStatusChangeTime

Date lastStatusChangeTime

The time from the last status change.

Class com.amazonaws.services.config.model.ConfigurationItem

class ConfigurationItem extends Object implements Serializable

Serialized Fields

accountId

String accountId

The 12 digit AWS account ID associated with the resource.

arn

String arn

The Amazon Resource Name (ARN) of the resource.

availabilityZone

String availabilityZone

The Availability Zone associated with the resource.

awsRegion

String awsRegion

The region where the resource resides.

configuration

String configuration

The description of the resource configuration.

configurationItemCaptureTime

Date configurationItemCaptureTime

The time when the configuration recording was initiated.

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.

configurationItemStatus

String configurationItemStatus

The configuration item status.

configurationStateId

String configurationStateId

An identifier that indicates the ordering of the configuration items of a resource.

relatedEvents

com.amazonaws.internal.SdkInternalList<String> 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<Relationship> relationships

A list of related AWS resources.

resourceCreationTime

Date resourceCreationTime

The time stamp when the resource was created.

resourceId

String resourceId

The ID of the resource (for example., sg-xxxxxx).

resourceName

String resourceName

The custom name of the resource, if available.

resourceType

String resourceType

The type of AWS resource.

tags

Map<String,String> tags

A mapping of key value tags associated with the resource.

version

String version

The version number of the resource configuration.

Class com.amazonaws.services.config.model.ConfigurationRecorder

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

recordingGroup

RecordingGroup recordingGroup

Specifies the types of AWS resource for which AWS Config records configuration changes.

roleARN

String roleARN

Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.

Class com.amazonaws.services.config.model.ConfigurationRecorderStatus

class ConfigurationRecorderStatus extends Object implements Serializable

Serialized Fields

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.

lastStartTime

Date lastStartTime

The time the recorder was last started.

lastStatus

String lastStatus

The last (previous) status of the recorder.

lastStatusChangeTime

Date lastStatusChangeTime

The time when the status was last changed.

lastStopTime

Date lastStopTime

The time the recorder was last stopped.

name

String name

The name of the configuration recorder.

recording

Boolean recording

Specifies whether the recorder is currently recording or not.

Class com.amazonaws.services.config.model.DeleteConfigRuleRequest

class 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.DeleteConfigRuleResult

class DeleteConfigRuleResult extends Object implements Serializable

Class com.amazonaws.services.config.model.DeleteDeliveryChannelRequest

class DeleteDeliveryChannelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryChannelName

String deliveryChannelName

The name of the delivery channel to delete.

Class com.amazonaws.services.config.model.DeleteDeliveryChannelResult

class DeleteDeliveryChannelResult extends Object implements Serializable

Class com.amazonaws.services.config.model.DeliverConfigSnapshotRequest

class 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

class 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

class DeliveryChannel extends Object implements Serializable

Serialized Fields

configSnapshotDeliveryProperties

ConfigSnapshotDeliveryProperties configSnapshotDeliveryProperties

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.

Class com.amazonaws.services.config.model.DeliveryChannelStatus

class DeliveryChannelStatus extends Object implements Serializable

Serialized Fields

configHistoryDeliveryInfo

ConfigExportDeliveryInfo configHistoryDeliveryInfo

A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

configSnapshotDeliveryInfo

ConfigExportDeliveryInfo configSnapshotDeliveryInfo

A list containing the status of the delivery of the snapshot 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.

name

String name

The name of the delivery channel.

Class com.amazonaws.services.config.model.DescribeComplianceByConfigRuleRequest

class DescribeComplianceByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

complianceTypes

com.amazonaws.internal.SdkInternalList<String> complianceTypes

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT , and INSUFFICIENT_DATA.

configRuleNames

com.amazonaws.internal.SdkInternalList<String> configRuleNames

Specify one or more AWS Config rule names to filter the results by rule.

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

class DescribeComplianceByConfigRuleResult extends Object implements Serializable

Serialized Fields

complianceByConfigRules

com.amazonaws.internal.SdkInternalList<ComplianceByConfigRule> 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

class DescribeComplianceByResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

complianceTypes

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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.

Class com.amazonaws.services.config.model.DescribeComplianceByResourceResult

class DescribeComplianceByResourceResult extends Object implements Serializable

Serialized Fields

complianceByResources

com.amazonaws.internal.SdkInternalList<ComplianceByResource> 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

class DescribeConfigRuleEvaluationStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configRuleNames

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeConfigRuleEvaluationStatusResult extends Object implements Serializable

Serialized Fields

configRulesEvaluationStatus

com.amazonaws.internal.SdkInternalList<ConfigRuleEvaluationStatus> configRulesEvaluationStatus

Status information about your AWS managed Config rules.

Class com.amazonaws.services.config.model.DescribeConfigRulesRequest

class DescribeConfigRulesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configRuleNames

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeConfigRulesResult extends Object implements Serializable

Serialized Fields

configRules

com.amazonaws.internal.SdkInternalList<ConfigRule> 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

class DescribeConfigurationRecordersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationRecorderNames

com.amazonaws.internal.SdkInternalList<String> configurationRecorderNames

A list of configuration recorder names.

Class com.amazonaws.services.config.model.DescribeConfigurationRecordersResult

class DescribeConfigurationRecordersResult extends Object implements Serializable

Serialized Fields

configurationRecorders

com.amazonaws.internal.SdkInternalList<ConfigurationRecorder> configurationRecorders

A list that contains the descriptions of the specified configuration recorders.

Class com.amazonaws.services.config.model.DescribeConfigurationRecorderStatusRequest

class DescribeConfigurationRecorderStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationRecorderNames

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeConfigurationRecorderStatusResult extends Object implements Serializable

Serialized Fields

configurationRecordersStatus

com.amazonaws.internal.SdkInternalList<ConfigurationRecorderStatus> configurationRecordersStatus

A list that contains status of the specified recorders.

Class com.amazonaws.services.config.model.DescribeDeliveryChannelsRequest

class DescribeDeliveryChannelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryChannelNames

com.amazonaws.internal.SdkInternalList<String> deliveryChannelNames

A list of delivery channel names.

Class com.amazonaws.services.config.model.DescribeDeliveryChannelsResult

class DescribeDeliveryChannelsResult extends Object implements Serializable

Serialized Fields

deliveryChannels

com.amazonaws.internal.SdkInternalList<DeliveryChannel> deliveryChannels

A list that contains the descriptions of the specified delivery channel.

Class com.amazonaws.services.config.model.DescribeDeliveryChannelStatusRequest

class DescribeDeliveryChannelStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryChannelNames

com.amazonaws.internal.SdkInternalList<String> deliveryChannelNames

A list of delivery channel names.

Class com.amazonaws.services.config.model.DescribeDeliveryChannelStatusResult

class DescribeDeliveryChannelStatusResult extends Object implements Serializable

Serialized Fields

deliveryChannelsStatus

com.amazonaws.internal.SdkInternalList<DeliveryChannelStatus> deliveryChannelsStatus

A list that contains the status of a specified delivery channel.

Class com.amazonaws.services.config.model.Evaluation

class Evaluation extends Object implements Serializable

Serialized Fields

annotation

String annotation

Supplementary information about how the evaluation determined the compliance.

complianceResourceId

String complianceResourceId

The ID of the AWS resource that was evaluated.

complianceResourceType

String complianceResourceType

The type of 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.

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

class EvaluationResult extends Object implements Serializable

Serialized Fields

annotation

String annotation

Supplementary information about how the evaluation determined the compliance.

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.

configRuleInvokedTime

Date configRuleInvokedTime

The time when the AWS Config rule evaluated the AWS resource.

evaluationResultIdentifier

EvaluationResultIdentifier evaluationResultIdentifier

Uniquely identifies the evaluation result.

resultRecordedTime

Date resultRecordedTime

The time when AWS Config recorded the evaluation result.

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

class 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

class EvaluationResultQualifier extends Object implements Serializable

Serialized Fields

configRuleName

String configRuleName

The name of the AWS Config rule that was used in the evaluation.

resourceId

String resourceId

The ID of the evaluated AWS resource.

resourceType

String resourceType

The type of AWS resource that was evaluated.

Class com.amazonaws.services.config.model.GetComplianceDetailsByConfigRuleRequest

class GetComplianceDetailsByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

complianceTypes

com.amazonaws.internal.SdkInternalList<String> complianceTypes

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT , and NOT_APPLICABLE.

configRuleName

String configRuleName

The name of the AWS Config rule for which you want compliance information.

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

class GetComplianceDetailsByConfigRuleResult extends Object implements Serializable

Serialized Fields

evaluationResults

com.amazonaws.internal.SdkInternalList<EvaluationResult> 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

class GetComplianceDetailsByResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

complianceTypes

com.amazonaws.internal.SdkInternalList<String> 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.

resourceId

String resourceId

The ID of the AWS resource for which you want compliance information.

resourceType

String resourceType

The type of the AWS resource for which you want compliance information.

Class com.amazonaws.services.config.model.GetComplianceDetailsByResourceResult

class GetComplianceDetailsByResourceResult extends Object implements Serializable

Serialized Fields

evaluationResults

com.amazonaws.internal.SdkInternalList<EvaluationResult> 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

class GetComplianceSummaryByConfigRuleRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.config.model.GetComplianceSummaryByConfigRuleResult

class 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

class GetComplianceSummaryByResourceTypeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceTypes

com.amazonaws.internal.SdkInternalList<String> 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

class GetComplianceSummaryByResourceTypeResult extends Object implements Serializable

Serialized Fields

complianceSummariesByResourceType

com.amazonaws.internal.SdkInternalList<ComplianceSummaryByResourceType> 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

class GetResourceConfigHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

chronologicalOrder

String chronologicalOrder

The chronological order for configuration items listed. By default the results are listed in reverse chronological order.

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.

laterTime

Date laterTime

The time stamp that indicates a later time. If not specified, current time is taken.

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.

resourceId

String resourceId

The ID of the resource (for example., sg-xxxxxx).

resourceType

String resourceType

The resource type.

Class com.amazonaws.services.config.model.GetResourceConfigHistoryResult

class GetResourceConfigHistoryResult extends Object implements Serializable

Serialized Fields

configurationItems

com.amazonaws.internal.SdkInternalList<ConfigurationItem> 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.

Exception Class com.amazonaws.services.config.model.InsufficientDeliveryPolicyException

class InsufficientDeliveryPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InsufficientPermissionsException

class InsufficientPermissionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidConfigurationRecorderNameException

class InvalidConfigurationRecorderNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidDeliveryChannelNameException

class InvalidDeliveryChannelNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidLimitException

class InvalidLimitException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidParameterValueException

class InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidRecordingGroupException

class InvalidRecordingGroupException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidResultTokenException

class InvalidResultTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidRoleException

class InvalidRoleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidS3KeyPrefixException

class InvalidS3KeyPrefixException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidSNSTopicARNException

class InvalidSNSTopicARNException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.InvalidTimeRangeException

class InvalidTimeRangeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.LastDeliveryChannelDeleteFailedException

class LastDeliveryChannelDeleteFailedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.config.model.ListDiscoveredResourcesRequest

class ListDiscoveredResourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

includeDeletedResources

Boolean includeDeletedResources

Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.

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.

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.

resourceIds

com.amazonaws.internal.SdkInternalList<String> 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.

resourceType

String resourceType

The type of resources that you want AWS Config to list in the response.

Class com.amazonaws.services.config.model.ListDiscoveredResourcesResult

class ListDiscoveredResourcesResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The string that you use in a subsequent request to get the next page of results in a paginated response.

resourceIdentifiers

com.amazonaws.internal.SdkInternalList<ResourceIdentifier> 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.

Exception Class com.amazonaws.services.config.model.MaxNumberOfConfigRulesExceededException

class MaxNumberOfConfigRulesExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.MaxNumberOfConfigurationRecordersExceededException

class MaxNumberOfConfigurationRecordersExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.MaxNumberOfDeliveryChannelsExceededException

class MaxNumberOfDeliveryChannelsExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.NoAvailableConfigurationRecorderException

class NoAvailableConfigurationRecorderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.NoAvailableDeliveryChannelException

class NoAvailableDeliveryChannelException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.NoRunningConfigurationRecorderException

class NoRunningConfigurationRecorderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.NoSuchBucketException

class NoSuchBucketException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.NoSuchConfigRuleException

class NoSuchConfigRuleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.NoSuchConfigurationRecorderException

class NoSuchConfigurationRecorderException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.NoSuchDeliveryChannelException

class NoSuchDeliveryChannelException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.config.model.PutConfigRuleRequest

class PutConfigRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configRule

ConfigRule configRule

Class com.amazonaws.services.config.model.PutConfigRuleResult

class PutConfigRuleResult extends Object implements Serializable

Class com.amazonaws.services.config.model.PutConfigurationRecorderRequest

class 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.PutConfigurationRecorderResult

class PutConfigurationRecorderResult extends Object implements Serializable

Class com.amazonaws.services.config.model.PutDeliveryChannelRequest

class 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.PutDeliveryChannelResult

class PutDeliveryChannelResult extends Object implements Serializable

Class com.amazonaws.services.config.model.PutEvaluationsRequest

class PutEvaluationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

evaluations

com.amazonaws.internal.SdkInternalList<Evaluation> 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

class PutEvaluationsResult extends Object implements Serializable

Serialized Fields

failedEvaluations

com.amazonaws.internal.SdkInternalList<Evaluation> failedEvaluations

Requests that failed because of a client or server error.

Class com.amazonaws.services.config.model.RecordingGroup

class 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<String> 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

class Relationship extends Object implements Serializable

Serialized Fields

relationshipName

String relationshipName

The type of relationship with 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.

resourceType

String resourceType

The resource type of the related resource.

Class com.amazonaws.services.config.model.ResourceIdentifier

class ResourceIdentifier extends Object implements Serializable

Serialized Fields

resourceDeletionTime

Date resourceDeletionTime

The time that the resource was deleted.

resourceId

String resourceId

The ID of the resource (for example., sg-xxxxxx).

resourceName

String resourceName

The custom name of the resource (if available).

resourceType

String resourceType

The type of resource.

Exception Class com.amazonaws.services.config.model.ResourceInUseException

class ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.config.model.ResourceNotDiscoveredException

class ResourceNotDiscoveredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.config.model.Scope

class Scope extends Object implements Serializable

Serialized Fields

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.

complianceResourceTypes

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.config.model.Source

class Source extends Object implements Serializable

Serialized Fields

owner

String owner

Indicates whether AWS or the customer owns and manages the AWS Config rule.

sourceDetails

com.amazonaws.internal.SdkInternalList<SourceDetail> sourceDetails

Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.

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.

Class com.amazonaws.services.config.model.SourceDetail

class 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

class 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.StartConfigurationRecorderResult

class StartConfigurationRecorderResult extends Object implements Serializable

Class com.amazonaws.services.config.model.StopConfigurationRecorderRequest

class 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.StopConfigurationRecorderResult

class StopConfigurationRecorderResult extends Object implements Serializable

Exception Class com.amazonaws.services.config.model.ValidationException

class ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.databasemigrationservice.model

Exception Class com.amazonaws.services.databasemigrationservice.model.AccessDeniedException

class AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.databasemigrationservice.model.AccountQuota

class AccountQuota extends Object implements Serializable

Serialized Fields

accountQuotaName

String accountQuotaName

The name of the AWS DMS quota for this AWS account.

max

Long max

The maximum allowed value for the quota.

used

Long used

The amount currently used toward the quota maximum.

Class com.amazonaws.services.databasemigrationservice.model.AddTagsToResourceRequest

class 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<Tag> tags

The tag to be assigned to the DMS resource.

Class com.amazonaws.services.databasemigrationservice.model.AddTagsToResourceResult

class AddTagsToResourceResult extends Object implements Serializable

Class com.amazonaws.services.databasemigrationservice.model.AvailabilityZone

class AvailabilityZone extends Object implements Serializable

Serialized Fields

name

String name

The name of the availability zone.

Class com.amazonaws.services.databasemigrationservice.model.Connection

class Connection extends Object implements Serializable

Serialized Fields

endpointArn

String endpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

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.

lastFailureMessage

String lastFailureMessage

The error message when the connection last failed.

replicationInstanceArn

String replicationInstanceArn

The Amazon Resource Name (ARN) of the replication instance.

replicationInstanceIdentifier

String replicationInstanceIdentifier

The replication instance identifier. This parameter is stored as a lowercase string.

status

String status

The connection status.

Class com.amazonaws.services.databasemigrationservice.model.CreateEndpointRequest

class CreateEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

databaseName

String databaseName

The name of the endpoint database.

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.

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.

password

String password

The password to be used to login to the endpoint database.

port

Integer port

The port used by the endpoint database.

serverName

String serverName

The name of the server where the endpoint database resides.

tags

List<Tag> tags

Tags to be added to the endpoint.

username

String username

The user name to be used to login to the endpoint database.

Class com.amazonaws.services.databasemigrationservice.model.CreateEndpointResult

class CreateEndpointResult extends Object implements Serializable

Serialized Fields

endpoint

Endpoint endpoint

The endpoint that was created.

Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationInstanceRequest

class CreateReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

The amount of storage (in gigabytes) to be initially allocated for 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

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

engineVersion

String engineVersion

The engine version number of 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.

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.

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.

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

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

replicationSubnetGroupIdentifier

String replicationSubnetGroupIdentifier

A subnet group to associate with the replication instance.

tags

List<Tag> tags

Tags to be associated with the replication instance.

Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationInstanceResult

class CreateReplicationInstanceResult extends Object implements Serializable

Serialized Fields

replicationInstance

ReplicationInstance replicationInstance

The replication instance that was created.

Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationSubnetGroupRequest

class CreateReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

replicationSubnetGroupDescription

String replicationSubnetGroupDescription

The description for the subnet group.

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

subnetIds

List<String> subnetIds

The EC2 subnet IDs for the subnet group.

tags

List<Tag> tags

The tag to be assigned to the subnet group.

Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationSubnetGroupResult

class CreateReplicationSubnetGroupResult extends Object implements Serializable

Serialized Fields

replicationSubnetGroup

ReplicationSubnetGroup replicationSubnetGroup

The replication subnet group that was created.

Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationTaskRequest

class CreateReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cdcStartTime

Date cdcStartTime

The start time for the Change Data Capture (CDC) operation.

migrationType

String migrationType

The migration type.

replicationInstanceArn

String replicationInstanceArn

The Amazon Resource Name (ARN) of the replication instance.

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.

replicationTaskSettings

String replicationTaskSettings

Settings for the task, such as target metadata settings.

sourceEndpointArn

String sourceEndpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

tableMappings

String tableMappings

The path of the JSON file that contains the table mappings.

tags

List<Tag> tags

Tags to be added to the replication instance.

targetEndpointArn

String targetEndpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Class com.amazonaws.services.databasemigrationservice.model.CreateReplicationTaskResult

class CreateReplicationTaskResult extends Object implements Serializable

Serialized Fields

replicationTask

ReplicationTask replicationTask

The replication task that was created.

Class com.amazonaws.services.databasemigrationservice.model.DeleteEndpointRequest

class 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

class DeleteEndpointResult extends Object implements Serializable

Serialized Fields

endpoint

Endpoint endpoint

The endpoint that was deleted.

Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationInstanceRequest

class 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

class DeleteReplicationInstanceResult extends Object implements Serializable

Serialized Fields

replicationInstance

ReplicationInstance replicationInstance

The replication instance that was deleted.

Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationSubnetGroupRequest

class 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

class DeleteReplicationSubnetGroupResult extends Object implements Serializable

Class com.amazonaws.services.databasemigrationservice.model.DeleteReplicationTaskRequest

class 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

class DeleteReplicationTaskResult extends Object implements Serializable

Serialized Fields

replicationTask

ReplicationTask replicationTask

The deleted replication task.

Class com.amazonaws.services.databasemigrationservice.model.DescribeAccountAttributesRequest

class DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.databasemigrationservice.model.DescribeAccountAttributesResult

class DescribeAccountAttributesResult extends Object implements Serializable

Serialized Fields

accountQuotas

List<AccountQuota> accountQuotas

Account quota information.

Class com.amazonaws.services.databasemigrationservice.model.DescribeConnectionsRequest

class DescribeConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<Filter> filters

The filters applied to the connection.

Valid filter names: endpoint-arn | replication-instance-arn

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.

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.databasemigrationservice.model.DescribeConnectionsResult

class DescribeConnectionsResult extends Object implements Serializable

Serialized Fields

connections

List<Connection> connections

A description of the connections.

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

class DescribeEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<Filter> filters

Filters applied to the describe action.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

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.

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.databasemigrationservice.model.DescribeEndpointsResult

class DescribeEndpointsResult extends Object implements Serializable

Serialized Fields

endpoints

List<Endpoint> endpoints

Endpoint description.

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

class DescribeEndpointTypesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<Filter> filters

Filters applied to the describe action.

Valid filter names: engine-name | endpoint-type

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.

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.databasemigrationservice.model.DescribeEndpointTypesResult

class 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<SupportedEndpointType> supportedEndpointTypes

The type of endpoints that are supported.

Class com.amazonaws.services.databasemigrationservice.model.DescribeOrderableReplicationInstancesRequest

class DescribeOrderableReplicationInstancesRequest extends AmazonWebServiceRequest 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.

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.databasemigrationservice.model.DescribeOrderableReplicationInstancesResult

class DescribeOrderableReplicationInstancesResult 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.

orderableReplicationInstances

List<OrderableReplicationInstance> orderableReplicationInstances

The order-able replication instances available.

Class com.amazonaws.services.databasemigrationservice.model.DescribeRefreshSchemasStatusRequest

class 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

class DescribeRefreshSchemasStatusResult extends Object implements Serializable

Serialized Fields

refreshSchemasStatus

RefreshSchemasStatus refreshSchemasStatus

The status of the schema.

Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationInstancesRequest

class DescribeReplicationInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<Filter> filters

Filters applied to the describe action.

Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version

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.

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.databasemigrationservice.model.DescribeReplicationInstancesResult

class 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<ReplicationInstance> replicationInstances

The replication instances described.

Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationSubnetGroupsRequest

class DescribeReplicationSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<Filter> filters

Filters applied to the describe action.

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.

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.databasemigrationservice.model.DescribeReplicationSubnetGroupsResult

class 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<ReplicationSubnetGroup> replicationSubnetGroups

A description of the replication subnet groups.

Class com.amazonaws.services.databasemigrationservice.model.DescribeReplicationTasksRequest

class DescribeReplicationTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

List<Filter> filters

Filters applied to the describe action.

Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

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.

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.databasemigrationservice.model.DescribeReplicationTasksResult

class 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<ReplicationTask> replicationTasks

A description of the replication tasks.

Class com.amazonaws.services.databasemigrationservice.model.DescribeSchemasRequest

class DescribeSchemasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endpointArn

String endpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

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.

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.databasemigrationservice.model.DescribeSchemasResult

class 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<String> schemas

The described schema.

Class com.amazonaws.services.databasemigrationservice.model.DescribeTableStatisticsRequest

class DescribeTableStatisticsRequest extends AmazonWebServiceRequest 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.

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.

replicationTaskArn

String replicationTaskArn

The Amazon Resource Name (ARN) of the replication task.

Class com.amazonaws.services.databasemigrationservice.model.DescribeTableStatisticsResult

class DescribeTableStatisticsResult 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.

replicationTaskArn

String replicationTaskArn

The Amazon Resource Name (ARN) of the replication task.

tableStatistics

List<TableStatistics> tableStatistics

The table statistics.

Class com.amazonaws.services.databasemigrationservice.model.Endpoint

class Endpoint extends Object implements Serializable

Serialized Fields

databaseName

String databaseName

The name of the database at the endpoint.

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

extraConnectionAttributes

String extraConnectionAttributes

Additional connection attributes used to connect to 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.

port

Integer port

The port value used to access the endpoint.

serverName

String serverName

The name of the server at the endpoint.

status

String status

The status of the endpoint.

username

String username

The user name used to connect to the endpoint.

Class com.amazonaws.services.databasemigrationservice.model.Filter

class Filter extends Object implements Serializable

Serialized Fields

name

String name

The name of the filter.

values

List<String> values

The filter value.

Exception Class com.amazonaws.services.databasemigrationservice.model.InsufficientResourceCapacityException

class InsufficientResourceCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.databasemigrationservice.model.InvalidResourceStateException

class InvalidResourceStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.databasemigrationservice.model.InvalidSubnetException

class InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.databasemigrationservice.model.KMSKeyNotAccessibleException

class KMSKeyNotAccessibleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.databasemigrationservice.model.ListTagsForResourceRequest

class 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

class ListTagsForResourceResult extends Object implements Serializable

Serialized Fields

tagList

List<Tag> tagList

A list of tags for the resource.

Class com.amazonaws.services.databasemigrationservice.model.ModifyEndpointRequest

class ModifyEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

databaseName

String databaseName

The name of the endpoint database.

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.

extraConnectionAttributes

String extraConnectionAttributes

Additional attributes associated with the connection.

password

String password

The password to be used to login to the endpoint database.

port

Integer port

The port used by the endpoint database.

serverName

String serverName

The name of the server where the endpoint database resides.

username

String username

The user name to be used to login to the endpoint database.

Class com.amazonaws.services.databasemigrationservice.model.ModifyEndpointResult

class ModifyEndpointResult extends Object implements Serializable

Serialized Fields

endpoint

Endpoint endpoint

The modified endpoint.

Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationInstanceRequest

class ModifyReplicationInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

The amount of storage (in gigabytes) to be allocated for 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.

applyImmediately

Boolean applyImmediately

Indicates whether the changes should be applied immediately or during the next maintenance window.

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.

engineVersion

String engineVersion

The engine version number of the replication instance.

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

replicationInstanceArn

String replicationInstanceArn

The Amazon Resource Name (ARN) of the replication instance.

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

replicationInstanceIdentifier

String replicationInstanceIdentifier

The replication instance identifier. This parameter is stored as a lowercase string.

Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationInstanceResult

class ModifyReplicationInstanceResult extends Object implements Serializable

Serialized Fields

replicationInstance

ReplicationInstance replicationInstance

The modified replication instance.

Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationSubnetGroupRequest

class ModifyReplicationSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

replicationSubnetGroupDescription

String replicationSubnetGroupDescription

The description of the replication instance subnet group.

replicationSubnetGroupIdentifier

String replicationSubnetGroupIdentifier

The name of the replication instance subnet group.

subnetIds

List<String> subnetIds

A list of subnet IDs.

Class com.amazonaws.services.databasemigrationservice.model.ModifyReplicationSubnetGroupResult

class ModifyReplicationSubnetGroupResult extends Object implements Serializable

Serialized Fields

replicationSubnetGroup

ReplicationSubnetGroup replicationSubnetGroup

The modified replication subnet group.

Class com.amazonaws.services.databasemigrationservice.model.OrderableReplicationInstance

class OrderableReplicationInstance extends Object implements Serializable

Serialized Fields

defaultAllocatedStorage

Integer defaultAllocatedStorage

The default amount of storage (in gigabytes) that is allocated for the replication instance.

engineVersion

String engineVersion

The version of the replication engine.

includedAllocatedStorage

Integer includedAllocatedStorage

The amount of storage (in gigabytes) that is allocated for the replication instance.

maxAllocatedStorage

Integer maxAllocatedStorage

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

minAllocatedStorage

Integer minAllocatedStorage

The minimum amount of storage (in gigabytes) that can be allocated for the replication instance.

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.

Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasRequest

class 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

class RefreshSchemasResult extends Object implements Serializable

Serialized Fields

refreshSchemasStatus

RefreshSchemasStatus refreshSchemasStatus

The status of the refreshed schema.

Class com.amazonaws.services.databasemigrationservice.model.RefreshSchemasStatus

class RefreshSchemasStatus extends Object implements Serializable

Serialized Fields

endpointArn

String endpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

lastFailureMessage

String lastFailureMessage

The last failure message for the schema.

lastRefreshDate

Date lastRefreshDate

The date the schema was last refreshed.

replicationInstanceArn

String replicationInstanceArn

The Amazon Resource Name (ARN) of the replication instance.

status

String status

The status of the schema.

Class com.amazonaws.services.databasemigrationservice.model.RemoveTagsFromResourceRequest

class 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<String> tagKeys

The tag key (name) of the tag to be removed.

Class com.amazonaws.services.databasemigrationservice.model.RemoveTagsFromResourceResult

class RemoveTagsFromResourceResult extends Object implements Serializable

Class com.amazonaws.services.databasemigrationservice.model.ReplicationInstance

class ReplicationInstance extends Object implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

The amount of storage (in gigabytes) that is allocated for the replication instance.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

availabilityZone

String availabilityZone

The Availability Zone for the instance.

engineVersion

String engineVersion

The engine version number of the replication instance.

instanceCreateTime

Date instanceCreateTime

The time the replication instance was created.

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.

pendingModifiedValues

ReplicationPendingModifiedValues pendingModifiedValues

The pending modification values.

preferredMaintenanceWindow

String preferredMaintenanceWindow

The maintenance window times for 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.

replicationInstanceArn

String replicationInstanceArn

The Amazon Resource Name (ARN) of the replication instance.

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

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

replicationInstancePrivateIpAddress

String replicationInstancePrivateIpAddress

The private IP address of the replication instance.

replicationInstancePublicIpAddress

String replicationInstancePublicIpAddress

The public IP address of the replication instance.

replicationInstanceStatus

String replicationInstanceStatus

The status of the replication instance.

replicationSubnetGroup

ReplicationSubnetGroup replicationSubnetGroup

The subnet group for the replication instance.

Class com.amazonaws.services.databasemigrationservice.model.ReplicationPendingModifiedValues

class ReplicationPendingModifiedValues extends Object implements Serializable

Serialized Fields

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.

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

Class com.amazonaws.services.databasemigrationservice.model.ReplicationSubnetGroup

class ReplicationSubnetGroup extends Object implements Serializable

Serialized Fields

replicationSubnetGroupDescription

String replicationSubnetGroupDescription

The description of the replication subnet group.

replicationSubnetGroupIdentifier

String replicationSubnetGroupIdentifier

The identifier of the replication instance subnet group.

subnetGroupStatus

String subnetGroupStatus

The status of the subnet group.

subnets

List<Subnet> subnets

The subnets that are in the subnet group.

vpcId

String vpcId

The ID of the VPC.

Exception Class com.amazonaws.services.databasemigrationservice.model.ReplicationSubnetGroupDoesNotCoverEnoughAZsException

class ReplicationSubnetGroupDoesNotCoverEnoughAZsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.databasemigrationservice.model.ReplicationTask

class ReplicationTask extends Object implements Serializable

Serialized Fields

lastFailureMessage

String lastFailureMessage

The last error (failure) message generated for the replication instance.

migrationType

String migrationType

The type of migration.

replicationInstanceArn

String replicationInstanceArn

The Amazon Resource Name (ARN) of the replication instance.

replicationTaskArn

String replicationTaskArn

The Amazon Resource Name (ARN) of the replication task.

replicationTaskCreationDate

Date replicationTaskCreationDate

The date the replication task was created.

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.

replicationTaskSettings

String replicationTaskSettings

The settings for the replication task.

replicationTaskStartDate

Date replicationTaskStartDate

The date the replication task is scheduled to start.

replicationTaskStats

ReplicationTaskStats replicationTaskStats

The statistics for the task, including elapsed time, tables loaded, and table errors.

sourceEndpointArn

String sourceEndpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

status

String status

The status of the replication task.

tableMappings

String tableMappings

Table mappings specified in the task.

targetEndpointArn

String targetEndpointArn

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

Class com.amazonaws.services.databasemigrationservice.model.ReplicationTaskStats

class ReplicationTaskStats extends Object implements Serializable

Serialized Fields

elapsedTimeMillis

Long elapsedTimeMillis

The elapsed time of the task, in milliseconds.

fullLoadProgressPercent

Integer fullLoadProgressPercent

The percent complete for the full load migration task.

tablesErrored

Integer tablesErrored

The number of errors that have occurred during this task.

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.

Exception Class com.amazonaws.services.databasemigrationservice.model.ResourceAlreadyExistsException

class ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.databasemigrationservice.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.databasemigrationservice.model.ResourceQuotaExceededException

class ResourceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskRequest

class StartReplicationTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cdcStartTime

Date cdcStartTime

The start time for the Change Data Capture (CDC) operation.

replicationTaskArn

String replicationTaskArn

The Amazon Resource Number (ARN) of the replication task to be started.

startReplicationTaskType

String startReplicationTaskType

The type of replication task.

Class com.amazonaws.services.databasemigrationservice.model.StartReplicationTaskResult

class StartReplicationTaskResult extends Object implements Serializable

Serialized Fields

replicationTask

ReplicationTask replicationTask

The replication task started.

Class com.amazonaws.services.databasemigrationservice.model.StopReplicationTaskRequest

class 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

class StopReplicationTaskResult extends Object implements Serializable

Serialized Fields

replicationTask

ReplicationTask replicationTask

The replication task stopped.

Exception Class com.amazonaws.services.databasemigrationservice.model.StorageQuotaExceededException

class StorageQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.databasemigrationservice.model.Subnet

class Subnet extends Object implements Serializable

Serialized Fields

subnetAvailabilityZone

AvailabilityZone subnetAvailabilityZone

The Availability Zone of the subnet.

subnetIdentifier

String subnetIdentifier

The subnet identifier.

subnetStatus

String subnetStatus

The status of the subnet.

Exception Class com.amazonaws.services.databasemigrationservice.model.SubnetAlreadyInUseException

class SubnetAlreadyInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.databasemigrationservice.model.SupportedEndpointType

class SupportedEndpointType extends Object implements Serializable

Serialized Fields

endpointType

String endpointType

The type of endpoint.

engineName

String engineName

The database engine name.

supportsCDC

Boolean supportsCDC

Indicates if Change Data Capture (CDC) is supported.

Class com.amazonaws.services.databasemigrationservice.model.TableStatistics

class TableStatistics extends Object implements Serializable

Serialized Fields

ddls

Long ddls

The Data Definition Language (DDL) used to build and modify the structure of your tables.

deletes

Long deletes

The number of delete actions performed on a table.

fullLoadRows

Long fullLoadRows

The number of rows added during the Full Load operation.

inserts

Long inserts

The number of insert actions performed on a table.

lastUpdateTime

Date lastUpdateTime

The last time the table was updated.

schemaName

String schemaName

The schema name.

tableName

String tableName

The name of the table.

tableState

String tableState

The state of the table.

updates

Long updates

The number of update actions performed on a table.

Class com.amazonaws.services.databasemigrationservice.model.Tag

class 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

class TestConnectionRequest 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 Number (ARN) of the replication instance.

Class com.amazonaws.services.databasemigrationservice.model.TestConnectionResult

class TestConnectionResult extends Object implements Serializable

Serialized Fields

connection

Connection connection

The connection tested.

Exception Class com.amazonaws.services.databasemigrationservice.model.UpgradeDependencyFailureException

class UpgradeDependencyFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.datapipeline.model

Class com.amazonaws.services.datapipeline.model.ActivatePipelineRequest

class ActivatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterValues

com.amazonaws.internal.SdkInternalList<ParameterValue> parameterValues

A list of parameter values to pass to the pipeline at activation.

pipelineId

String pipelineId

The ID of the pipeline.

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

class ActivatePipelineResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.AddTagsRequest

class AddTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

The tags to add, as key/value pairs.

Class com.amazonaws.services.datapipeline.model.AddTagsResult

class AddTagsResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.CreatePipelineRequest

class CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

The description for the pipeline.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.

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.

Class com.amazonaws.services.datapipeline.model.CreatePipelineResult

class 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

class DeactivatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

pipelineId

String pipelineId

The ID of the pipeline.

Class com.amazonaws.services.datapipeline.model.DeactivatePipelineResult

class DeactivatePipelineResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.DeletePipelineRequest

class DeletePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

Class com.amazonaws.services.datapipeline.model.DeletePipelineResult

class DeletePipelineResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.DescribeObjectsRequest

class DescribeObjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

objectIds

com.amazonaws.internal.SdkInternalList<String> 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.

pipelineId

String pipelineId

The ID of the pipeline that contains the object definitions.

Class com.amazonaws.services.datapipeline.model.DescribeObjectsResult

class DescribeObjectsResult extends Object implements Serializable

Serialized Fields

hasMoreResults

Boolean hasMoreResults

Indicates whether there are more results to return.

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.

pipelineObjects

com.amazonaws.internal.SdkInternalList<PipelineObject> pipelineObjects

An array of object definitions.

Class com.amazonaws.services.datapipeline.model.DescribePipelinesRequest

class DescribePipelinesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineIds

com.amazonaws.internal.SdkInternalList<String> 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

class DescribePipelinesResult extends Object implements Serializable

Serialized Fields

pipelineDescriptionList

com.amazonaws.internal.SdkInternalList<PipelineDescription> pipelineDescriptionList

An array of descriptions for the specified pipelines.

Class com.amazonaws.services.datapipeline.model.EvaluateExpressionRequest

class EvaluateExpressionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

expression

String expression

The expression to evaluate.

objectId

String objectId

The ID of the object.

pipelineId

String pipelineId

The ID of the pipeline.

Class com.amazonaws.services.datapipeline.model.EvaluateExpressionResult

class EvaluateExpressionResult extends Object implements Serializable

Serialized Fields

evaluatedExpression

String evaluatedExpression

The evaluated expression.

Class com.amazonaws.services.datapipeline.model.Field

class Field extends Object implements Serializable

Serialized Fields

key

String key

The field identifier.

refValue

String refValue

The field value, expressed as the identifier of another object.

stringValue

String stringValue

The field value, expressed as a String.

Class com.amazonaws.services.datapipeline.model.GetPipelineDefinitionRequest

class 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

class GetPipelineDefinitionResult extends Object implements Serializable

Serialized Fields

parameterObjects

com.amazonaws.internal.SdkInternalList<ParameterObject> parameterObjects

The parameter objects used in the pipeline definition.

parameterValues

com.amazonaws.internal.SdkInternalList<ParameterValue> parameterValues

The parameter values used in the pipeline definition.

pipelineObjects

com.amazonaws.internal.SdkInternalList<PipelineObject> pipelineObjects

The objects defined in the pipeline.

Class com.amazonaws.services.datapipeline.model.InstanceIdentity

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

Exception Class com.amazonaws.services.datapipeline.model.InternalServiceErrorException

class InternalServiceErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.datapipeline.model.InvalidRequestException

class InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.ListPipelinesRequest

class 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

class ListPipelinesResult extends Object implements Serializable

Serialized Fields

hasMoreResults

Boolean hasMoreResults

Indicates whether there are more results that can be obtained by a subsequent call.

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.

pipelineIdList

com.amazonaws.internal.SdkInternalList<PipelineIdName> pipelineIdList

The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

Class com.amazonaws.services.datapipeline.model.Operator

class 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<String> values

The value that the actual field value will be compared with.

Class com.amazonaws.services.datapipeline.model.ParameterAttribute

class 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

class ParameterObject extends Object implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.SdkInternalList<ParameterAttribute> attributes

The attributes of the parameter object.

id

String id

The ID of the parameter object.

Class com.amazonaws.services.datapipeline.model.ParameterValue

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

Exception Class com.amazonaws.services.datapipeline.model.PipelineDeletedException

class PipelineDeletedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.PipelineDescription

class PipelineDescription extends Object implements Serializable

Serialized Fields

description

String description

Description of the pipeline.

fields

com.amazonaws.internal.SdkInternalList<Field> fields

A list of read-only fields that contain metadata about the pipeline:

name

String name

The name of the pipeline.

pipelineId

String pipelineId

The pipeline identifier that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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

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

Exception Class com.amazonaws.services.datapipeline.model.PipelineNotFoundException

class PipelineNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.PipelineObject

class PipelineObject extends Object implements Serializable

Serialized Fields

fields

com.amazonaws.internal.SdkInternalList<Field> fields

Key-value pairs that define the properties of the object.

id

String id

The ID of the object.

name

String name

The name of the object.

Class com.amazonaws.services.datapipeline.model.PollForTaskRequest

class PollForTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.datapipeline.model.PollForTaskResult

class 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

class PutPipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterObjects

com.amazonaws.internal.SdkInternalList<ParameterObject> parameterObjects

The parameter objects used with the pipeline.

parameterValues

com.amazonaws.internal.SdkInternalList<ParameterValue> parameterValues

The parameter values used with the pipeline.

pipelineId

String pipelineId

The ID of the pipeline.

pipelineObjects

com.amazonaws.internal.SdkInternalList<PipelineObject> pipelineObjects

The objects that define the pipeline. These objects overwrite the existing pipeline definition.

Class com.amazonaws.services.datapipeline.model.PutPipelineDefinitionResult

class PutPipelineDefinitionResult extends Object implements Serializable

Serialized Fields

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.

validationErrors

com.amazonaws.internal.SdkInternalList<ValidationError> validationErrors

The validation errors that are associated with the objects defined in pipelineObjects.

validationWarnings

com.amazonaws.internal.SdkInternalList<ValidationWarning> validationWarnings

The validation warnings that are associated with the objects defined in pipelineObjects.

Class com.amazonaws.services.datapipeline.model.Query

class Query extends Object implements Serializable

Serialized Fields

selectors

com.amazonaws.internal.SdkInternalList<Selector> 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

class QueryObjectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

Integer limit

The maximum number of object names that QueryObjects will return in a single call. The default value is 100.

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.

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.

Class com.amazonaws.services.datapipeline.model.QueryObjectsResult

class QueryObjectsResult extends Object implements Serializable

Serialized Fields

hasMoreResults

Boolean hasMoreResults

Indicates whether there are more results that can be obtained by a subsequent call.

ids

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.datapipeline.model.RemoveTagsRequest

class RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

pipelineId

String pipelineId

The ID of the pipeline.

tagKeys

com.amazonaws.internal.SdkInternalList<String> tagKeys

The keys of the tags to remove.

Class com.amazonaws.services.datapipeline.model.RemoveTagsResult

class RemoveTagsResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.ReportTaskProgressRequest

class ReportTaskProgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fields

com.amazonaws.internal.SdkInternalList<Field> fields

Key-value pairs that define the properties of the ReportTaskProgressInput object.

taskId

String taskId

The ID of the task assigned to the task runner. This value is provided in the response for PollForTask.

Class com.amazonaws.services.datapipeline.model.ReportTaskProgressResult

class 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

class ReportTaskRunnerHeartbeatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hostname

String hostname

The public DNS name of the task runner.

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.

Class com.amazonaws.services.datapipeline.model.ReportTaskRunnerHeartbeatResult

class 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

class 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

class SetStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

objectIds

com.amazonaws.internal.SdkInternalList<String> objectIds

The IDs of the objects. The corresponding objects can be either physical or components, but not a mix of both types.

pipelineId

String pipelineId

The ID of the pipeline that contains the objects.

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

class SetStatusResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.SetTaskStatusRequest

class SetTaskStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.datapipeline.model.SetTaskStatusResult

class SetTaskStatusResult extends Object implements Serializable

Class com.amazonaws.services.datapipeline.model.Tag

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

Exception Class com.amazonaws.services.datapipeline.model.TaskNotFoundException

class TaskNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.datapipeline.model.TaskObject

class TaskObject extends Object implements Serializable

Serialized Fields

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<String, PipelineObject> objects

Connection information for the location where the task runner will publish the output of the task.

pipelineId

String pipelineId

The ID of the pipeline that provided the task.

taskId

String taskId

An internal identifier for the task. This ID is passed to the SetTaskStatus and ReportTaskProgress actions.

Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionRequest

class ValidatePipelineDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

parameterObjects

com.amazonaws.internal.SdkInternalList<ParameterObject> parameterObjects

The parameter objects used with the pipeline.

parameterValues

com.amazonaws.internal.SdkInternalList<ParameterValue> parameterValues

The parameter values used with the pipeline.

pipelineId

String pipelineId

The ID of the pipeline.

pipelineObjects

com.amazonaws.internal.SdkInternalList<PipelineObject> pipelineObjects

The objects that define the pipeline changes to validate against the pipeline.

Class com.amazonaws.services.datapipeline.model.ValidatePipelineDefinitionResult

class ValidatePipelineDefinitionResult extends Object implements Serializable

Serialized Fields

errored

Boolean errored

Indicates whether there were validation errors.

validationErrors

com.amazonaws.internal.SdkInternalList<ValidationError> validationErrors

Any validation errors that were found.

validationWarnings

com.amazonaws.internal.SdkInternalList<ValidationWarning> validationWarnings

Any validation warnings that were found.

Class com.amazonaws.services.datapipeline.model.ValidationError

class ValidationError extends Object implements Serializable

Serialized Fields

errors

com.amazonaws.internal.SdkInternalList<String> errors

A description of the validation error.

id

String id

The identifier of the object that contains the validation error.

Class com.amazonaws.services.datapipeline.model.ValidationWarning

class 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<String> warnings

A description of the validation warning.

Package com.amazonaws.services.devicefarm.model

Class com.amazonaws.services.devicefarm.model.AccountSettings

class AccountSettings extends Object implements Serializable

Serialized Fields

awsAccountNumber

String awsAccountNumber

The AWS account number specified in the AccountSettings container.

unmeteredDevices

Map<String,Integer> unmeteredDevices

Returns the unmetered devices you have purchased or want to purchase.

unmeteredRemoteAccessDevices

Map<String,Integer> unmeteredRemoteAccessDevices

Returns the unmetered remote access devices you have purchased or want to purchase.

Exception Class com.amazonaws.services.devicefarm.model.ArgumentException

class ArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.devicefarm.model.Artifact

class Artifact extends Object implements Serializable

Serialized Fields

arn

String arn

The artifact's ARN.

extension

String extension

The artifact's file extension.

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.

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

class Counters extends Object implements Serializable

Serialized Fields

errored

Integer errored

The number of errored entities.

failed

Integer failed

The number of failed entities.

passed

Integer passed

The number of passed entities.

skipped

Integer skipped

The number of skipped entities.

stopped

Integer stopped

The number of stopped entities.

total

Integer total

The total number of entities.

warned

Integer warned

The number of warned entities.

Class com.amazonaws.services.devicefarm.model.CPU

class CPU extends Object implements Serializable

Serialized Fields

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.

frequency

String frequency

The CPU's frequency.

Class com.amazonaws.services.devicefarm.model.CreateDevicePoolRequest

class CreateDevicePoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

The device pool's description.

name

String name

The device pool's name.

projectArn

String projectArn

The ARN of the project for the device pool.

rules

List<Rule> rules

The device pool's rules.

Class com.amazonaws.services.devicefarm.model.CreateDevicePoolResult

class CreateDevicePoolResult extends Object implements Serializable

Serialized Fields

devicePool

DevicePool devicePool

The newly created device pool.

Class com.amazonaws.services.devicefarm.model.CreateProjectRequest

class CreateProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The project's name.

Class com.amazonaws.services.devicefarm.model.CreateProjectResult

class CreateProjectResult extends Object implements Serializable

Serialized Fields

project

Project project

The newly created project.

Class com.amazonaws.services.devicefarm.model.CreateUploadRequest

class CreateUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

contentType

String contentType

The upload's content type (for example, "application/octet-stream").

name

String name

The upload's file name.

projectArn

String projectArn

The ARN of the project for the upload.

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.

Class com.amazonaws.services.devicefarm.model.CreateUploadResult

class CreateUploadResult extends Object implements Serializable

Serialized Fields

upload

Upload upload

The newly created upload.

Class com.amazonaws.services.devicefarm.model.DeleteDevicePoolRequest

class 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

class DeleteDevicePoolResult extends Object implements Serializable

Class com.amazonaws.services.devicefarm.model.DeleteProjectRequest

class 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

class DeleteProjectResult extends Object implements Serializable

Class com.amazonaws.services.devicefarm.model.DeleteRunRequest

class 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

class DeleteRunResult extends Object implements Serializable

Class com.amazonaws.services.devicefarm.model.DeleteUploadRequest

class 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

class DeleteUploadResult extends Object implements Serializable

Class com.amazonaws.services.devicefarm.model.Device

class Device extends Object implements Serializable

Serialized Fields

arn

String arn

The device's ARN.

carrier

String carrier

The device's carrier.

cpu

CPU cpu

Information about the device's CPU.

formFactor

String formFactor

The device's form factor.

Allowed values include:

• PHONE: The phone form factor.

• TABLET: The tablet form factor.

heapSize

Long heapSize

The device's heap size, expressed in bytes.

image

String image

The device's image name.

manufacturer

String manufacturer

The device's manufacturer name.

memory

Long memory

The device's total memory size, expressed in bytes.

model

String model

The device's model name.

name

String name

The device's display name.

os

String os

The device's operating system type.

platform

String platform

The device's platform.

Allowed values include:

• ANDROID: The Android platform.

• IOS: The iOS platform.

radio

String radio

The device's radio.

resolution

Resolution resolution

Class com.amazonaws.services.devicefarm.model.DeviceMinutes

class DeviceMinutes extends Object implements Serializable

Serialized Fields

metered

Double metered

When specified, represents only the sum of metered minutes used by the resource to run tests.

total

Double total

When specified, represents the total 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

class DevicePool extends Object implements Serializable

Serialized Fields

arn

String arn

The device pool's ARN.

description

String description

The device pool's description.

name

String name

The device pool's name.

rules

List<Rule> rules

Information about the device pool's rules.

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.

Class com.amazonaws.services.devicefarm.model.DevicePoolCompatibilityResult

class DevicePoolCompatibilityResult extends Object implements Serializable

Serialized Fields

compatible

Boolean compatible

Whether the result was compatible with the device pool.

device

Device device

incompatibilityMessages

List<IncompatibilityMessage> incompatibilityMessages

Information about the compatibility.

Class com.amazonaws.services.devicefarm.model.GetAccountSettingsRequest

class GetAccountSettingsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.devicefarm.model.GetAccountSettingsResult

class GetAccountSettingsResult extends Object implements Serializable

Serialized Fields

accountSettings

AccountSettings accountSettings

Class com.amazonaws.services.devicefarm.model.GetDevicePoolCompatibilityRequest

class GetDevicePoolCompatibilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appArn

String appArn

The ARN of the app that is associated with the specified device pool.

devicePoolArn

String devicePoolArn

The device pool's ARN.

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

class GetDevicePoolCompatibilityResult extends Object implements Serializable

Serialized Fields

compatibleDevices

List<DevicePoolCompatibilityResult> compatibleDevices

Information about compatible devices.

incompatibleDevices

List<DevicePoolCompatibilityResult> incompatibleDevices

Information about incompatible devices.

Class com.amazonaws.services.devicefarm.model.GetDevicePoolRequest

class GetDevicePoolRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The device pool's ARN.

Class com.amazonaws.services.devicefarm.model.GetDevicePoolResult

class GetDevicePoolResult extends Object implements Serializable

Serialized Fields

devicePool

DevicePool devicePool

Class com.amazonaws.services.devicefarm.model.GetDeviceRequest

class GetDeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The device type's ARN.

Class com.amazonaws.services.devicefarm.model.GetDeviceResult

class GetDeviceResult extends Object implements Serializable

Serialized Fields

device

Device device

Class com.amazonaws.services.devicefarm.model.GetJobRequest

class GetJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The job's ARN.

Class com.amazonaws.services.devicefarm.model.GetJobResult

class GetJobResult extends Object implements Serializable

Serialized Fields

job

Job job

Class com.amazonaws.services.devicefarm.model.GetOfferingStatusRequest

class 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

class GetOfferingStatusResult extends Object implements Serializable

Serialized Fields

current

Map<String, OfferingStatus> current

When specified, gets the offering status for the current period.

nextPeriod

Map<String, OfferingStatus> 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

class GetProjectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The project's ARN.

Class com.amazonaws.services.devicefarm.model.GetProjectResult

class GetProjectResult extends Object implements Serializable

Serialized Fields

project

Project project

Class com.amazonaws.services.devicefarm.model.GetRunRequest

class GetRunRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The run's ARN.

Class com.amazonaws.services.devicefarm.model.GetRunResult

class GetRunResult extends Object implements Serializable

Serialized Fields

run

Run run

Class com.amazonaws.services.devicefarm.model.GetSuiteRequest

class GetSuiteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The suite's ARN.

Class com.amazonaws.services.devicefarm.model.GetSuiteResult

class GetSuiteResult extends Object implements Serializable

Serialized Fields

suite

Suite suite

Class com.amazonaws.services.devicefarm.model.GetTestRequest

class GetTestRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The test's ARN.

Class com.amazonaws.services.devicefarm.model.GetTestResult

class GetTestResult extends Object implements Serializable

Serialized Fields

test

Test test

Class com.amazonaws.services.devicefarm.model.GetUploadRequest

class GetUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The upload's ARN.

Class com.amazonaws.services.devicefarm.model.GetUploadResult

class GetUploadResult extends Object implements Serializable

Serialized Fields

upload

Upload upload

Exception Class com.amazonaws.services.devicefarm.model.IdempotencyException

class IdempotencyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.devicefarm.model.IncompatibilityMessage

class 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

class Job extends Object implements Serializable

Serialized Fields

arn

String arn

The job's ARN.

counters

Counters counters

The job's result counters.

created

Date created

When the job was created.

device

Device device

deviceMinutes

DeviceMinutes deviceMinutes

Represents the total (metered or unmetered) minutes used by the job.

message

String message

A message about the job's result.

name

String name

The job's name.

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.

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.

stopped

Date stopped

The job's stop time.

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.

Exception Class com.amazonaws.services.devicefarm.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.devicefarm.model.ListArtifactsRequest

class ListArtifactsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The Run, Job, Suite, or Test ARN.

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.

type

String type

The artifacts' type.

Allowed values include:

• FILE: The artifacts are files.
• LOG: The artifacts are logs.
• SCREENSHOT: The artifacts are screenshots.

Class com.amazonaws.services.devicefarm.model.ListArtifactsResult

class ListArtifactsResult extends Object implements Serializable

Serialized Fields

artifacts

List<Artifact> 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

class ListDevicePoolsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

arn

String arn

The project ARN.

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.

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.

Class com.amazonaws.services.devicefarm.model.ListDevicePoolsResult

class ListDevicePoolsResult extends Object implements Serializable

Serialized Fields

devicePools

List<DevicePool> 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

class 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

class ListDevicesResult extends Object implements Serializable

Serialized Fields

devices

List<Device> 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

class 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

class ListJobsResult extends Object implements Serializable

Serialized Fields

jobs

List<Job> 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

class 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

class ListOfferingsResult extends Object 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.

offerings

List<Offering> offerings

A value representing the list offering results.

Class com.amazonaws.services.devicefarm.model.ListOfferingTransactionsRequest

class 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

class ListOfferingTransactionsResult extends Object 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.

offeringTransactions

List<OfferingTransaction> offeringTransactions

The audit log of subscriptions you have purchased and modified through AWS Device Farm.

Class com.amazonaws.services.devicefarm.model.ListProjectsRequest

class 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

class ListProjectsResult extends Object implements Serializable

Serialized Fields

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.

projects

List<Project> projects

Information about the projects.

Class com.amazonaws.services.devicefarm.model.ListRunsRequest

class 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

class ListRunsResult extends Object implements Serializable

Serialized Fields

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.

runs

List<Run> runs

Information about the runs.

Class com.amazonaws.services.devicefarm.model.ListSamplesRequest

class 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

class ListSamplesResult extends Object implements Serializable

Serialized Fields

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.

samples

List<Sample> samples

Information about the samples.

Class com.amazonaws.services.devicefarm.model.ListSuitesRequest

class 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

class ListSuitesResult extends Object implements Serializable

Serialized Fields

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.

suites

List<Suite> suites

Information about the suites.

Class com.amazonaws.services.devicefarm.model.ListTestsRequest

class 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

class ListTestsResult extends Object implements Serializable

Serialized Fields

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.

tests

List<Test> tests

Information about the tests.

Class com.amazonaws.services.devicefarm.model.ListUniqueProblemsRequest

class 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

class ListUniqueProblemsResult extends Object implements Serializable

Serialized Fields

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.

uniqueProblems

Map<String, List<UniqueProblem>> 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.

Class com.amazonaws.services.devicefarm.model.ListUploadsRequest

class 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

class ListUploadsResult extends Object implements Serializable

Serialized Fields

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.

uploads

List<Upload> uploads

Information about the uploads.

Class com.amazonaws.services.devicefarm.model.Location

class Location extends Object implements Serializable

Serialized Fields

latitude

Double latitude

The latitude.

longitude

Double longitude

The longitude.

Class com.amazonaws.services.devicefarm.model.MonetaryAmount

class 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."

Exception Class com.amazonaws.services.devicefarm.model.NotEligibleException

class NotEligibleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.devicefarm.model.NotFoundException

class NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.devicefarm.model.Offering

class Offering extends Object implements Serializable

Serialized Fields

description

String description

A string describing the offering.

id

String id

The ID that corresponds to a device offering.

platform

String platform

The platform of the device (e.g., ANDROID or IOS).

recurringCharges

List<RecurringCharge> recurringCharges

Specifies whether there are recurring charges for the offering.

type

String type

The type of offering (e.g., "RECURRING") for a device.

Class com.amazonaws.services.devicefarm.model.OfferingStatus

class OfferingStatus extends Object implements Serializable

Serialized Fields

effectiveOn

Date effectiveOn

The date on which the offering is effective.

offering

Offering offering

Represents the metadata of an offering status.

quantity

Integer quantity

The number of available devices in the offering.

type

String type

The type specified for the offering status.

Class com.amazonaws.services.devicefarm.model.OfferingTransaction

class OfferingTransaction extends Object implements Serializable

Serialized Fields

cost

MonetaryAmount cost

The cost of an offering transaction.

createdOn

Date createdOn

The date on which an offering transaction was created.

offeringStatus

OfferingStatus offeringStatus

The status of an offering transaction.

transactionId

String transactionId

The transaction ID of the offering transaction.

Class com.amazonaws.services.devicefarm.model.Problem

class Problem extends Object implements Serializable

Serialized Fields

device

Device device

Information about the associated device.

job

ProblemDetail job

Information about the associated job.

message

String message

A message about the problem's result.

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.

run

ProblemDetail run

Information about the associated run.

suite

ProblemDetail suite

Information about the associated suite.

test

ProblemDetail test

Information about the associated test.

Class com.amazonaws.services.devicefarm.model.ProblemDetail

class 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

class Project extends Object implements Serializable

Serialized Fields

arn

String arn

The project's ARN.

created

Date created

When the project was created.

name

String name

The project's name.

Class com.amazonaws.services.devicefarm.model.PurchaseOfferingRequest

class 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

class 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

class Radios extends Object implements Serializable

Serialized Fields

bluetooth

Boolean bluetooth

True if Bluetooth 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.

nfc

Boolean nfc

True if NFC is enabled at the beginning of the test; otherwise, false.

wifi

Boolean wifi

True if Wi-Fi is enabled at the beginning of the test; otherwise, false.

Class com.amazonaws.services.devicefarm.model.RecurringCharge

class 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

class 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

class 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

class Resolution extends Object implements Serializable

Serialized Fields

height

Integer height

The screen resolution's height, expressed in pixels.

width

Integer width

The screen resolution's width, expressed in pixels.

Class com.amazonaws.services.devicefarm.model.Rule

class 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

class Run extends Object implements Serializable

Serialized Fields

arn

String arn

The run's ARN.

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.

completedJobs

Integer completedJobs

The total number of completed jobs.

counters

Counters counters

The run's result counters.

created

Date created

When the run was created.

deviceMinutes

DeviceMinutes deviceMinutes

Represents the total (metered or unmetered) minutes used by the test run.

message

String message

A message about the run's result.

name

String name

The run's name.

platform

String platform

The run's platform.

Allowed values include:

• ANDROID: The Android platform.

• IOS: The iOS platform.

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.

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.

stopped

Date stopped

The run's stop time.

totalJobs

Integer totalJobs

The total number of jobs for the run.

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.

Class com.amazonaws.services.devicefarm.model.Sample

class 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

class ScheduleRunConfiguration extends Object implements Serializable

Serialized Fields

auxiliaryApps

List<String> 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.

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.

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.

networkProfileArn

String networkProfileArn

Reserved for internal use.

radios

Radios radios

Information about the radio states for the run.

Class com.amazonaws.services.devicefarm.model.ScheduleRunRequest

class ScheduleRunRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appArn

String appArn

The ARN of the app to schedule a run.

configuration

ScheduleRunConfiguration configuration

Information about the settings for the run to be scheduled.

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.

projectArn

String projectArn

The ARN of the project for the run to be scheduled.

test

ScheduleRunTest test

Information about the test for the run to be scheduled.

Class com.amazonaws.services.devicefarm.model.ScheduleRunResult

class ScheduleRunResult extends Object implements Serializable

Serialized Fields

run

Run run

Information about the scheduled run.

Class com.amazonaws.services.devicefarm.model.ScheduleRunTest

class ScheduleRunTest extends Object implements Serializable

Serialized Fields

filter

String filter

The test's filter.

parameters

Map<String,String> parameters

The test's parameters, such as test framework parameters and fixture settings.

testPackageArn

String testPackageArn

The ARN of the uploaded test that will be run.

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.

Exception Class com.amazonaws.services.devicefarm.model.ServiceAccountException

class ServiceAccountException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.devicefarm.model.StopRunRequest

class 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

class StopRunResult extends Object implements Serializable

Serialized Fields

run

Run run

Class com.amazonaws.services.devicefarm.model.Suite

class Suite extends Object implements Serializable

Serialized Fields

arn

String arn

The suite's ARN.

counters

Counters counters

The suite's result counters.

created

Date created

When the suite was created.

deviceMinutes

DeviceMinutes deviceMinutes

Represents the total (metered or unmetered) minutes used by the test suite.

message

String message

A message about the suite's result.

name

String name

The suite's name.

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.

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.

stopped

Date stopped

The suite's stop time.

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.

Class com.amazonaws.services.devicefarm.model.Test

class Test extends Object implements Serializable

Serialized Fields

arn

String arn

The test's ARN.

counters

Counters counters

The test's result counters.

created

Date created

When the test was created.

deviceMinutes

DeviceMinutes deviceMinutes

Represents the total (metered or unmetered) minutes used by the test.

message

String message

A message about the test's result.

name

String name

The test's name.

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.

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.

stopped

Date stopped

The test's stop time.

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.

Class com.amazonaws.services.devicefarm.model.UniqueProblem

class UniqueProblem extends Object implements Serializable

Serialized Fields

message

String message

A message about the unique problems' result.

problems

List<Problem> problems

Information about the problems.

Class com.amazonaws.services.devicefarm.model.UpdateDevicePoolRequest

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

description

String description

A description of the device pool you wish to update.

name

String name

A string representing the name of the device pool you wish to update.

rules

List<Rule> 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

class UpdateDevicePoolResult extends Object implements Serializable

Serialized Fields

devicePool

DevicePool devicePool

Class com.amazonaws.services.devicefarm.model.UpdateProjectRequest

class 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

class UpdateProjectResult extends Object implements Serializable

Serialized Fields

project

Project project

Class com.amazonaws.services.devicefarm.model.Upload

class Upload extends Object implements Serializable

Serialized Fields

arn

String arn

The upload's ARN.

contentType

String contentType

The upload's content type (for example, "application/octet-stream").

created

Date created

When the upload was created.

message

String message

A message about the upload's result.

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.

name

String name

The upload's file name.

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.

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.

url

String url

The pre-signed Amazon S3 URL that was used to store a file through a corresponding PUT request.

Package com.amazonaws.services.directconnect.model

Class com.amazonaws.services.directconnect.model.AllocateConnectionOnInterconnectRequest

class AllocateConnectionOnInterconnectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bandwidth

String bandwidth

Bandwidth of the connection.

Example: "500Mbps"

Default: None

Values: 50M, 100M, 200M, 300M, 400M, or 500M

connectionName

String connectionName

Name of the provisioned connection.

Example: "500M Connection to AWS"

Default: None

interconnectId

String interconnectId

ID of the interconnect on which the connection will be provisioned.

Example: dxcon-456abc78

Default: None

ownerAccount

String ownerAccount

Numeric account Id of the customer for whom the connection will be provisioned.

Example: 123443215678

Default: None

vlan

Integer vlan

The dedicated VLAN provisioned to the connection.

Example: 101

Default: None

Class com.amazonaws.services.directconnect.model.AllocateConnectionOnInterconnectResult

class AllocateConnectionOnInterconnectResult extends Object implements Serializable

Serialized Fields

bandwidth

String bandwidth

Bandwidth of the connection.

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

Default: None

connectionId

String connectionId

connectionName

String connectionName

connectionState

String connectionState

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new connection.

partnerName

String partnerName

The name of the AWS Direct Connect service provider associated with the connection.

region

String region

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.AllocatePrivateVirtualInterfaceRequest

class AllocatePrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

The connection ID on which the private virtual interface is provisioned.

Default: None

newPrivateVirtualInterfaceAllocation

NewPrivateVirtualInterfaceAllocation newPrivateVirtualInterfaceAllocation

Detailed information for the private virtual interface to be provisioned.

Default: None

ownerAccount

String ownerAccount

The AWS account that will own the new private virtual interface.

Default: None

Class com.amazonaws.services.directconnect.model.AllocatePrivateVirtualInterfaceResult

class AllocatePrivateVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

connectionId

String connectionId

customerAddress

String customerAddress

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new virtual interface.

routeFilterPrefixes

com.amazonaws.internal.SdkInternalList<RouteFilterPrefix> routeFilterPrefixes

virtualGatewayId

String virtualGatewayId

virtualInterfaceId

String virtualInterfaceId

virtualInterfaceName

String virtualInterfaceName

virtualInterfaceState

String virtualInterfaceState

virtualInterfaceType

String virtualInterfaceType

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.AllocatePublicVirtualInterfaceRequest

class AllocatePublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

The connection ID on which the public virtual interface is provisioned.

Default: None

newPublicVirtualInterfaceAllocation

NewPublicVirtualInterfaceAllocation newPublicVirtualInterfaceAllocation

Detailed information for the public virtual interface to be provisioned.

Default: None

ownerAccount

String ownerAccount

The AWS account that will own the new public virtual interface.

Default: None

Class com.amazonaws.services.directconnect.model.AllocatePublicVirtualInterfaceResult

class AllocatePublicVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

connectionId

String connectionId

customerAddress

String customerAddress

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new virtual interface.

routeFilterPrefixes

com.amazonaws.internal.SdkInternalList<RouteFilterPrefix> routeFilterPrefixes

virtualGatewayId

String virtualGatewayId

virtualInterfaceId

String virtualInterfaceId

virtualInterfaceName

String virtualInterfaceName

virtualInterfaceState

String virtualInterfaceState

virtualInterfaceType

String virtualInterfaceType

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.ConfirmConnectionRequest

class ConfirmConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

Class com.amazonaws.services.directconnect.model.ConfirmConnectionResult

class ConfirmConnectionResult extends Object implements Serializable

Serialized Fields

connectionState

String connectionState

Class com.amazonaws.services.directconnect.model.ConfirmPrivateVirtualInterfaceRequest

class ConfirmPrivateVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

virtualInterfaceId

String virtualInterfaceId

Class com.amazonaws.services.directconnect.model.ConfirmPrivateVirtualInterfaceResult

class ConfirmPrivateVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

virtualInterfaceState

String virtualInterfaceState

Class com.amazonaws.services.directconnect.model.ConfirmPublicVirtualInterfaceRequest

class ConfirmPublicVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

virtualInterfaceId

String virtualInterfaceId

Class com.amazonaws.services.directconnect.model.ConfirmPublicVirtualInterfaceResult

class ConfirmPublicVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

virtualInterfaceState

String virtualInterfaceState

Class com.amazonaws.services.directconnect.model.Connection

class Connection extends Object implements Serializable

Serialized Fields

bandwidth

String bandwidth

Bandwidth of the connection.

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

Default: None

connectionId

String connectionId

connectionName

String connectionName

connectionState

String connectionState

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new connection.

partnerName

String partnerName

The name of the AWS Direct Connect service provider associated with the connection.

region

String region

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.CreateConnectionRequest

class CreateConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bandwidth

String bandwidth

connectionName

String connectionName

location

String location

Class com.amazonaws.services.directconnect.model.CreateConnectionResult

class CreateConnectionResult extends Object implements Serializable

Serialized Fields

bandwidth

String bandwidth

Bandwidth of the connection.

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

Default: None

connectionId

String connectionId

connectionName

String connectionName

connectionState

String connectionState

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new connection.

partnerName

String partnerName

The name of the AWS Direct Connect service provider associated with the connection.

region

String region

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.CreateInterconnectRequest

class CreateInterconnectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bandwidth

String bandwidth

The port bandwidth

Example: 1Gbps

Default: None

Available values: 1Gbps,10Gbps

interconnectName

String interconnectName

The name of the interconnect.

Example: "1G Interconnect to AWS"

Default: None

location

String location

Where the interconnect is located

Example: EqSV5

Default: None

Class com.amazonaws.services.directconnect.model.CreateInterconnectResult

class CreateInterconnectResult extends Object implements Serializable

Serialized Fields

bandwidth

String bandwidth

interconnectId

String interconnectId

interconnectName

String interconnectName

interconnectState

String interconnectState

location

String location

region

String region

Class com.amazonaws.services.directconnect.model.CreatePrivateVirtualInterfaceRequest

class 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

class CreatePrivateVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

connectionId

String connectionId

customerAddress

String customerAddress

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new virtual interface.

routeFilterPrefixes

com.amazonaws.internal.SdkInternalList<RouteFilterPrefix> routeFilterPrefixes

virtualGatewayId

String virtualGatewayId

virtualInterfaceId

String virtualInterfaceId

virtualInterfaceName

String virtualInterfaceName

virtualInterfaceState

String virtualInterfaceState

virtualInterfaceType

String virtualInterfaceType

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.CreatePublicVirtualInterfaceRequest

class 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

class CreatePublicVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

connectionId

String connectionId

customerAddress

String customerAddress

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new virtual interface.

routeFilterPrefixes

com.amazonaws.internal.SdkInternalList<RouteFilterPrefix> routeFilterPrefixes

virtualGatewayId

String virtualGatewayId

virtualInterfaceId

String virtualInterfaceId

virtualInterfaceName

String virtualInterfaceName

virtualInterfaceState

String virtualInterfaceState

virtualInterfaceType

String virtualInterfaceType

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.DeleteConnectionRequest

class DeleteConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

Class com.amazonaws.services.directconnect.model.DeleteConnectionResult

class DeleteConnectionResult extends Object implements Serializable

Serialized Fields

bandwidth

String bandwidth

Bandwidth of the connection.

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

Default: None

connectionId

String connectionId

connectionName

String connectionName

connectionState

String connectionState

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new connection.

partnerName

String partnerName

The name of the AWS Direct Connect service provider associated with the connection.

region

String region

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.DeleteInterconnectRequest

class DeleteInterconnectRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

interconnectId

String interconnectId

Class com.amazonaws.services.directconnect.model.DeleteInterconnectResult

class DeleteInterconnectResult extends Object implements Serializable

Serialized Fields

interconnectState

String interconnectState

Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceRequest

class DeleteVirtualInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

virtualInterfaceId

String virtualInterfaceId

Class com.amazonaws.services.directconnect.model.DeleteVirtualInterfaceResult

class DeleteVirtualInterfaceResult extends Object implements Serializable

Serialized Fields

virtualInterfaceState

String virtualInterfaceState

Class com.amazonaws.services.directconnect.model.DescribeConnectionsOnInterconnectRequest

class 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

class DescribeConnectionsOnInterconnectResult extends Object implements Serializable

Serialized Fields

connections

com.amazonaws.internal.SdkInternalList<Connection> connections

A list of connections.

Class com.amazonaws.services.directconnect.model.DescribeConnectionsRequest

class DescribeConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

Class com.amazonaws.services.directconnect.model.DescribeConnectionsResult

class DescribeConnectionsResult extends Object implements Serializable

Serialized Fields

connections

com.amazonaws.internal.SdkInternalList<Connection> connections

A list of connections.

Class com.amazonaws.services.directconnect.model.DescribeInterconnectsRequest

class DescribeInterconnectsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

interconnectId

String interconnectId

Class com.amazonaws.services.directconnect.model.DescribeInterconnectsResult

class DescribeInterconnectsResult extends Object implements Serializable

Serialized Fields

interconnects

com.amazonaws.internal.SdkInternalList<Interconnect> interconnects

A list of interconnects.

Class com.amazonaws.services.directconnect.model.DescribeLocationsRequest

class DescribeLocationsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.directconnect.model.DescribeLocationsResult

class DescribeLocationsResult extends Object implements Serializable

Serialized Fields

locations

com.amazonaws.internal.SdkInternalList<Location> locations

A list of colocation hubs where network providers have equipment. Most regions have multiple locations available.

Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysRequest

class DescribeVirtualGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.directconnect.model.DescribeVirtualGatewaysResult

class DescribeVirtualGatewaysResult extends Object implements Serializable

Serialized Fields

virtualGateways

com.amazonaws.internal.SdkInternalList<VirtualGateway> virtualGateways

A list of virtual private gateways.

Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesRequest

class DescribeVirtualInterfacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectionId

String connectionId

virtualInterfaceId

String virtualInterfaceId

Class com.amazonaws.services.directconnect.model.DescribeVirtualInterfacesResult

class DescribeVirtualInterfacesResult extends Object implements Serializable

Serialized Fields

virtualInterfaces

com.amazonaws.internal.SdkInternalList<VirtualInterface> virtualInterfaces

A list of virtual interfaces.

Exception Class com.amazonaws.services.directconnect.model.DirectConnectClientException

class DirectConnectClientException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.directconnect.model.DirectConnectServerException

class DirectConnectServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.directconnect.model.Interconnect

class Interconnect extends Object implements Serializable

Serialized Fields

bandwidth

String bandwidth

interconnectId

String interconnectId

interconnectName

String interconnectName

interconnectState

String interconnectState

location

String location

region

String region

Class com.amazonaws.services.directconnect.model.Location

class 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

class NewPrivateVirtualInterface extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

customerAddress

String customerAddress

virtualGatewayId

String virtualGatewayId

virtualInterfaceName

String virtualInterfaceName

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.NewPrivateVirtualInterfaceAllocation

class NewPrivateVirtualInterfaceAllocation extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

customerAddress

String customerAddress

virtualInterfaceName

String virtualInterfaceName

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.NewPublicVirtualInterface

class NewPublicVirtualInterface extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

customerAddress

String customerAddress

routeFilterPrefixes

com.amazonaws.internal.SdkInternalList<RouteFilterPrefix> routeFilterPrefixes

virtualInterfaceName

String virtualInterfaceName

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.NewPublicVirtualInterfaceAllocation

class NewPublicVirtualInterfaceAllocation extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

customerAddress

String customerAddress

routeFilterPrefixes

com.amazonaws.internal.SdkInternalList<RouteFilterPrefix> routeFilterPrefixes

virtualInterfaceName

String virtualInterfaceName

vlan

Integer vlan

Class com.amazonaws.services.directconnect.model.RouteFilterPrefix

class 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

class VirtualGateway extends Object implements Serializable

Serialized Fields

virtualGatewayId

String virtualGatewayId

virtualGatewayState

String virtualGatewayState

Class com.amazonaws.services.directconnect.model.VirtualInterface

class VirtualInterface extends Object implements Serializable

Serialized Fields

amazonAddress

String amazonAddress

asn

Integer asn

authKey

String authKey

connectionId

String connectionId

customerAddress

String customerAddress

customerRouterConfig

String customerRouterConfig

Information for generating the customer router configuration.

location

String location

ownerAccount

String ownerAccount

The AWS account that will own the new virtual interface.

routeFilterPrefixes

com.amazonaws.internal.SdkInternalList<RouteFilterPrefix> routeFilterPrefixes

virtualGatewayId

String virtualGatewayId

virtualInterfaceId

String virtualInterfaceId

virtualInterfaceName

String virtualInterfaceName

virtualInterfaceState

String virtualInterfaceState

virtualInterfaceType

String virtualInterfaceType

vlan

Integer vlan

Package com.amazonaws.services.directory.model

Class com.amazonaws.services.directory.model.Attribute

class Attribute extends Object implements Serializable

Serialized Fields

name

String name

The name of the attribute.

value

String value

The value of the attribute.

Exception Class com.amazonaws.services.directory.model.AuthenticationFailedException

class AuthenticationFailedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

The identifier of the request that caused the exception.

Exception Class com.amazonaws.services.directory.model.ClientException

class ClientException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.Computer

class Computer extends Object implements Serializable

Serialized Fields

computerAttributes

com.amazonaws.internal.SdkInternalList<Attribute> computerAttributes

An array of Attribute objects containing the LDAP attributes that belong to the computer account.

computerId

String computerId

The identifier of the computer.

computerName

String computerName

The computer name.

Class com.amazonaws.services.directory.model.ConditionalForwarder

class ConditionalForwarder extends Object implements Serializable

Serialized Fields

dnsIpAddrs

com.amazonaws.internal.SdkInternalList<String> 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.

remoteDomainName

String remoteDomainName

The fully qualified domain name (FQDN) of the remote domains pointed to by the conditional forwarder.

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

class ConnectDirectoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

connectSettings

DirectoryConnectSettings connectSettings

A DirectoryConnectSettings object that contains additional information for the operation.

description

String description

A textual description for the directory.

name

String name

The fully-qualified name of the on-premises directory, such as corp.example.com.

password

String password

The password for the on-premises user account.

shortName

String shortName

The NetBIOS name of the on-premises directory, such as CORP.

size

String size

The size of the directory.

Class com.amazonaws.services.directory.model.ConnectDirectoryResult

class ConnectDirectoryResult extends Object implements Serializable

Serialized Fields

directoryId

String directoryId

The identifier of the new directory.

Class com.amazonaws.services.directory.model.CreateAliasRequest

class CreateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

directoryId

String directoryId

The identifier of the directory for which to create the alias.

Class com.amazonaws.services.directory.model.CreateAliasResult

class CreateAliasResult extends Object implements Serializable

Serialized Fields

alias

String alias

The alias for the directory.

directoryId

String directoryId

The identifier of the directory.

Class com.amazonaws.services.directory.model.CreateComputerRequest

class CreateComputerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

computerAttributes

com.amazonaws.internal.SdkInternalList<Attribute> computerAttributes

An array of Attribute objects that contain any LDAP attributes to apply to the computer account.

computerName

String computerName

The name of the computer account.

directoryId

String directoryId

The identifier of the directory in which to create the computer account.

organizationalUnitDistinguishedName

String organizationalUnitDistinguishedName

The fully-qualified distinguished name of the organizational unit to place the computer account in.

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.

Class com.amazonaws.services.directory.model.CreateComputerResult

class 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

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

dnsIpAddrs

com.amazonaws.internal.SdkInternalList<String> dnsIpAddrs

The IP addresses of the remote DNS server associated with RemoteDomainName.

remoteDomainName

String remoteDomainName

The fully qualified domain name (FQDN) of the remote domain with which you will set up a trust relationship.

Class com.amazonaws.services.directory.model.CreateConditionalForwarderResult

class CreateConditionalForwarderResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.CreateDirectoryRequest

class CreateDirectoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

A textual description for the directory.

name

String name

The fully qualified name for the directory, such as corp.example.com.

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.

shortName

String shortName

The short name of the directory, such as CORP.

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

class 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

class CreateMicrosoftADRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

password

String password

The password for the default administrative user named Admin .

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.

vpcSettings

DirectoryVpcSettings vpcSettings

Class com.amazonaws.services.directory.model.CreateMicrosoftADResult

class 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

class 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

class 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

class CreateTrustRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

conditionalForwarderIpAddrs

com.amazonaws.internal.SdkInternalList<String> conditionalForwarderIpAddrs

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.

trustDirection

String trustDirection

The direction of 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.

trustType

String trustType

The trust relationship type.

Class com.amazonaws.services.directory.model.CreateTrustResult

class 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

class 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

class DeleteConditionalForwarderResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.DeleteDirectoryRequest

class DeleteDirectoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

directoryId

String directoryId

The identifier of the directory to delete.

Class com.amazonaws.services.directory.model.DeleteDirectoryResult

class DeleteDirectoryResult extends Object implements Serializable

Serialized Fields

directoryId

String directoryId

The directory identifier.

Class com.amazonaws.services.directory.model.DeleteSnapshotRequest

class 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

class 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

class DeleteTrustRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deleteAssociatedConditionalForwarder

Boolean deleteAssociatedConditionalForwarder

trustId

String trustId

The Trust ID of the trust relationship to be deleted.

Class com.amazonaws.services.directory.model.DeleteTrustResult

class 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

class 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

class DeregisterEventTopicResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.DescribeConditionalForwardersRequest

class 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<String> 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

class DescribeConditionalForwardersResult extends Object implements Serializable

Serialized Fields

conditionalForwarders

com.amazonaws.internal.SdkInternalList<ConditionalForwarder> conditionalForwarders

The list of conditional forwarders that have been created.

Class com.amazonaws.services.directory.model.DescribeDirectoriesRequest

class DescribeDirectoriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

directoryIds

com.amazonaws.internal.SdkInternalList<String> 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.

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.

nextToken

String nextToken

The DescribeDirectoriesResult.NextToken value from a previous call to DescribeDirectories. Pass null if this is the first call.

Class com.amazonaws.services.directory.model.DescribeDirectoriesResult

class DescribeDirectoriesResult extends Object implements Serializable

Serialized Fields

directoryDescriptions

com.amazonaws.internal.SdkInternalList<DirectoryDescription> 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

class 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<String> 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

class DescribeEventTopicsResult extends Object implements Serializable

Serialized Fields

eventTopics

com.amazonaws.internal.SdkInternalList<EventTopic> eventTopics

A list of SNS topic names that receive status messages from the specified Directory ID.

Class com.amazonaws.services.directory.model.DescribeSnapshotsRequest

class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

directoryId

String directoryId

The identifier of the directory for which to retrieve snapshot information.

limit

Integer limit

The maximum number of objects to return.

nextToken

String nextToken

The DescribeSnapshotsResult.NextToken value from a previous call to DescribeSnapshots. Pass null if this is the first call.

snapshotIds

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.directory.model.DescribeSnapshotsResult

class DescribeSnapshotsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

If not null, more results are available. Pass this value in the NextToken member of a subsequent call to DescribeSnapshots.

snapshots

com.amazonaws.internal.SdkInternalList<Snapshot> 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.

Class com.amazonaws.services.directory.model.DescribeTrustsRequest

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

limit

Integer limit

The maximum number of objects to return.

nextToken

String nextToken

The DescribeTrustsResult.NextToken value from a previous call to DescribeTrusts. Pass null if this is the first call.

trustIds

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.directory.model.DescribeTrustsResult

class DescribeTrustsResult extends Object implements Serializable

Serialized Fields

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.

trusts

com.amazonaws.internal.SdkInternalList<Trust> 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.

Class com.amazonaws.services.directory.model.DirectoryConnectSettings

class DirectoryConnectSettings extends Object implements Serializable

Serialized Fields

customerDnsIps

com.amazonaws.internal.SdkInternalList<String> 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

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

A list of subnet identifiers in the VPC in which the AD Connector is created.

vpcId

String vpcId

The identifier of the VPC in which the AD Connector is created.

Class com.amazonaws.services.directory.model.DirectoryConnectSettingsDescription

class DirectoryConnectSettingsDescription extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

A list of the Availability Zones that the directory is in.

connectIps

com.amazonaws.internal.SdkInternalList<String> connectIps

The IP addresses of the AD Connector servers.

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.

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

A list of subnet identifiers in the VPC that the AD connector is in.

vpcId

String vpcId

The identifier of the VPC that the AD Connector is in.

Class com.amazonaws.services.directory.model.DirectoryDescription

class DirectoryDescription extends Object implements Serializable

Serialized Fields

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.

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.

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.

description

String description

The textual description for the directory.

directoryId

String directoryId

The directory identifier.

dnsIpAddrs

com.amazonaws.internal.SdkInternalList<String> 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.

launchTime

Date launchTime

Specifies when the directory was created.

name

String name

The fully-qualified name of the 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.

shortName

String shortName

The short name of the directory.

size

String size

The directory size.

ssoEnabled

Boolean ssoEnabled

Indicates if single-sign on is enabled for the directory. For more information, see EnableSso and DisableSso.

stage

String stage

The current stage of the directory.

stageLastUpdatedDateTime

Date stageLastUpdatedDateTime

The date and time that the stage was last updated.

stageReason

String stageReason

Additional information about the directory stage.

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.

Exception Class com.amazonaws.services.directory.model.DirectoryLimitExceededException

class DirectoryLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.DirectoryLimits

class DirectoryLimits extends Object implements Serializable

Serialized Fields

cloudOnlyDirectoriesCurrentCount

Integer cloudOnlyDirectoriesCurrentCount

The current number of cloud directories in the region.

cloudOnlyDirectoriesLimit

Integer cloudOnlyDirectoriesLimit

The maximum number of cloud directories allowed in the region.

cloudOnlyDirectoriesLimitReached

Boolean cloudOnlyDirectoriesLimitReached

Indicates if the cloud directory limit has been reached.

cloudOnlyMicrosoftADCurrentCount

Integer cloudOnlyMicrosoftADCurrentCount

The current number of Microsoft AD directories in the region.

cloudOnlyMicrosoftADLimit

Integer cloudOnlyMicrosoftADLimit

The maximum number of Microsoft AD directories allowed in the region.

cloudOnlyMicrosoftADLimitReached

Boolean cloudOnlyMicrosoftADLimitReached

Indicates if the Microsoft AD directory limit has been reached.

connectedDirectoriesCurrentCount

Integer connectedDirectoriesCurrentCount

The current number of connected directories in the region.

connectedDirectoriesLimit

Integer connectedDirectoriesLimit

The maximum number of connected directories allowed in the region.

connectedDirectoriesLimitReached

Boolean connectedDirectoriesLimitReached

Indicates if the connected directory limit has been reached.

Exception Class com.amazonaws.services.directory.model.DirectoryUnavailableException

class DirectoryUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.DirectoryVpcSettings

class DirectoryVpcSettings extends Object implements Serializable

Serialized Fields

subnetIds

com.amazonaws.internal.SdkInternalList<String> 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.

vpcId

String vpcId

The identifier of the VPC in which to create the directory.

Class com.amazonaws.services.directory.model.DirectoryVpcSettingsDescription

class DirectoryVpcSettingsDescription extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

The list of Availability Zones that the directory is in.

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.

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

The identifiers of the subnets for the directory servers.

vpcId

String vpcId

The identifier of the VPC that the directory is in.

Class com.amazonaws.services.directory.model.DisableRadiusRequest

class 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

class DisableRadiusResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.DisableSsoRequest

class DisableSsoRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

directoryId

String directoryId

The identifier of the directory for which to disable single-sign on.

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.

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.

Class com.amazonaws.services.directory.model.DisableSsoResult

class DisableSsoResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.EnableRadiusRequest

class 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

class EnableRadiusResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.EnableSsoRequest

class EnableSsoRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

directoryId

String directoryId

The identifier of the directory for which to enable single-sign on.

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.

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.

Class com.amazonaws.services.directory.model.EnableSsoResult

class EnableSsoResult extends Object implements Serializable

Exception Class com.amazonaws.services.directory.model.EntityAlreadyExistsException

class EntityAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Exception Class com.amazonaws.services.directory.model.EntityDoesNotExistException

class EntityDoesNotExistException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.EventTopic

class EventTopic extends Object implements Serializable

Serialized Fields

createdDateTime

Date createdDateTime

The date and time of when you associated your directory with the SNS topic.

directoryId

String directoryId

The Directory ID of an AWS Directory Service directory that will publish status messages to an SNS topic.

status

String status

The topic registration status.

topicArn

String topicArn

The SNS topic ARN (Amazon Resource Name).

topicName

String topicName

The name of an AWS SNS topic the receives status messages from the directory.

Class com.amazonaws.services.directory.model.GetDirectoryLimitsRequest

class GetDirectoryLimitsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.directory.model.GetDirectoryLimitsResult

class 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

class 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

class GetSnapshotLimitsResult extends Object implements Serializable

Serialized Fields

snapshotLimits

SnapshotLimits snapshotLimits

A SnapshotLimits object that contains the manual snapshot limits for the specified directory.

Exception Class com.amazonaws.services.directory.model.InsufficientPermissionsException

class InsufficientPermissionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Exception Class com.amazonaws.services.directory.model.InvalidNextTokenException

class InvalidNextTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Exception Class com.amazonaws.services.directory.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.RadiusSettings

class RadiusSettings extends Object implements Serializable

Serialized Fields

authenticationProtocol

String authenticationProtocol

The protocol specified for your RADIUS endpoints.

displayLabel

String displayLabel

Not currently used.

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.

radiusRetries

Integer radiusRetries

The maximum number of times that communication with the RADIUS server is attempted.

radiusServers

com.amazonaws.internal.SdkInternalList<String> 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.

radiusTimeout

Integer radiusTimeout

The amount of time, in seconds, to wait for the RADIUS server to respond.

sharedSecret

String sharedSecret

The shared secret code that was specified when your RADIUS endpoints were created.

useSameUsername

Boolean useSameUsername

Not currently used.

Class com.amazonaws.services.directory.model.RegisterEventTopicRequest

class 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

class RegisterEventTopicResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.RestoreFromSnapshotRequest

class 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

class RestoreFromSnapshotResult extends Object implements Serializable

Exception Class com.amazonaws.services.directory.model.ServiceException

class ServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.Snapshot

class Snapshot extends Object implements Serializable

Serialized Fields

directoryId

String directoryId

The directory identifier.

name

String name

The descriptive name of the snapshot.

snapshotId

String snapshotId

The snapshot identifier.

startTime

Date startTime

The date and time that the snapshot was taken.

status

String status

The snapshot status.

type

String type

The snapshot type.

Exception Class com.amazonaws.services.directory.model.SnapshotLimitExceededException

class SnapshotLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.SnapshotLimits

class SnapshotLimits extends Object implements Serializable

Serialized Fields

manualSnapshotsCurrentCount

Integer manualSnapshotsCurrentCount

The current number of manual snapshots of the directory.

manualSnapshotsLimit

Integer manualSnapshotsLimit

The maximum number of manual snapshots allowed.

manualSnapshotsLimitReached

Boolean manualSnapshotsLimitReached

Indicates if the manual snapshot limit has been reached.

Class com.amazonaws.services.directory.model.Trust

class Trust extends Object implements Serializable

Serialized Fields

createdDateTime

Date createdDateTime

The date and time that the trust relationship was created.

directoryId

String directoryId

The Directory ID of the AWS directory involved in the trust relationship.

lastUpdatedDateTime

Date lastUpdatedDateTime

The date and time that the trust relationship was last updated.

remoteDomainName

String remoteDomainName

The Fully Qualified Domain Name (FQDN) of the external domain involved in the trust relationship.

stateLastUpdatedDateTime

Date stateLastUpdatedDateTime

The date and time that the TrustState was last updated.

trustDirection

String trustDirection

The trust relationship direction.

trustId

String trustId

The unique ID of the trust relationship.

trustState

String trustState

The trust relationship state.

trustStateReason

String trustStateReason

The reason for the TrustState.

trustType

String trustType

The trust relationship type.

Exception Class com.amazonaws.services.directory.model.UnsupportedOperationException

class UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

requestId

String requestId

Class com.amazonaws.services.directory.model.UpdateConditionalForwarderRequest

class UpdateConditionalForwarderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

directoryId

String directoryId

The directory ID of the AWS directory for which to update the conditional forwarder.

dnsIpAddrs

com.amazonaws.internal.SdkInternalList<String> dnsIpAddrs

The updated IP addresses of the remote DNS server associated with 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.

Class com.amazonaws.services.directory.model.UpdateConditionalForwarderResult

class UpdateConditionalForwarderResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.UpdateRadiusRequest

class 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

class UpdateRadiusResult extends Object implements Serializable

Class com.amazonaws.services.directory.model.VerifyTrustRequest

class 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

class 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

Exception Class com.amazonaws.services.dynamodbv2.datamodeling.DynamoDBMappingException

class DynamoDBMappingException extends RuntimeException implements Serializable

serialVersionUID:

-4883173289978517967L

Package com.amazonaws.services.dynamodbv2.document

Exception Class com.amazonaws.services.dynamodbv2.document.IncompatibleTypeException

class IncompatibleTypeException extends AmazonClientException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.dynamodbv2.document.utils

Class com.amazonaws.services.dynamodbv2.document.utils.FluentArrayList

class FluentArrayList extends ArrayList<E> implements Serializable

serialVersionUID:

-8269850815375778149L

Class com.amazonaws.services.dynamodbv2.document.utils.FluentHashMap

class FluentHashMap extends LinkedHashMap<K,V> implements Serializable

serialVersionUID:

4857340227048063855L

Class com.amazonaws.services.dynamodbv2.document.utils.FluentHashSet

class FluentHashSet extends LinkedHashSet<E> implements Serializable

serialVersionUID:

-549868294257559427L

Class com.amazonaws.services.dynamodbv2.document.utils.NameMap

class NameMap extends FluentHashMap<String,String> implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.document.utils.ValueList

class ValueList extends FluentArrayList<Object> implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.document.utils.ValueMap

class ValueMap extends FluentHashMap<String,Object> implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.dynamodbv2.model

Class com.amazonaws.services.dynamodbv2.model.AttributeDefinition

class 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

class AttributeValue extends Object implements Serializable

Serialized Fields

b

ByteBuffer b

A Binary data type.

bOOL

Boolean bOOL

A Boolean data type.

bS

List<ByteBuffer> bS

A Binary Set data type.

l

List<AttributeValue> l

A List of attribute values.

m

Map<String, AttributeValue> m

A Map of attribute values.

n

String n

A Number data type.

nS

List<String> nS

A Number Set data type.

nULLValue

Boolean nULLValue

A Null data type.

s

String s

A String data type.

sS

List<String> sS

A String Set data type.

Class com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate

class AttributeValueUpdate extends Object implements Serializable

Serialized Fields

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.

value

AttributeValue value

Class com.amazonaws.services.dynamodbv2.model.BatchGetItemRequest

class BatchGetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

Map<String, KeysAndAttributes> 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

class BatchGetItemResult extends Object implements Serializable

Serialized Fields

consumedCapacity

List<ConsumedCapacity> 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.

responses

Map<String, List<Map<String, AttributeValue>>> 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<String, KeysAndAttributes> 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.

Class com.amazonaws.services.dynamodbv2.model.BatchWriteItemRequest

class BatchWriteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

requestItems

Map<String, List<WriteRequest>> 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

class BatchWriteItemResult extends Object implements Serializable

Serialized Fields

consumedCapacity

List<ConsumedCapacity> 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.

itemCollectionMetrics

Map<String, List<ItemCollectionMetrics>> 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.

unprocessedItems

Map<String, List<WriteRequest>> 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.

Class com.amazonaws.services.dynamodbv2.model.Capacity

class 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

class Condition extends Object implements Serializable

Serialized Fields

attributeValueList

List<AttributeValue> 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.

Exception Class com.amazonaws.services.dynamodbv2.model.ConditionalCheckFailedException

class ConditionalCheckFailedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ConsumedCapacity

class ConsumedCapacity extends Object implements Serializable

Serialized Fields

capacityUnits

Double capacityUnits

The total number of capacity units consumed by the operation.

globalSecondaryIndexes

Map<String,Capacity> globalSecondaryIndexes

The amount of throughput consumed on each global index affected by the operation.

localSecondaryIndexes

Map<String,Capacity> localSecondaryIndexes

The amount of throughput consumed on each local index affected by the operation.

table

Capacity table

The amount of throughput consumed on the table affected by the operation.

tableName

String tableName

The name of the table that was affected by the operation.

Class com.amazonaws.services.dynamodbv2.model.CreateGlobalSecondaryIndexAction

class CreateGlobalSecondaryIndexAction extends Object implements Serializable

Serialized Fields

indexName

String indexName

The name of the global secondary index to be created.

keySchema

List<KeySchemaElement> keySchema

The key schema for the global secondary index.

projection

Projection projection

provisionedThroughput

ProvisionedThroughput provisionedThroughput

Class com.amazonaws.services.dynamodbv2.model.CreateTableRequest

class CreateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeDefinitions

List<AttributeDefinition> attributeDefinitions

An array of attributes that describe the key schema for the table and indexes.

globalSecondaryIndexes

List<GlobalSecondaryIndex> 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.

keySchema

List<KeySchemaElement> 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<LocalSecondaryIndex> 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.

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.

tableName

String tableName

The name of the table to create.

Class com.amazonaws.services.dynamodbv2.model.CreateTableResult

class CreateTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Class com.amazonaws.services.dynamodbv2.model.DeleteGlobalSecondaryIndexAction

class 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

class DeleteItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

expected

Map<String, ExpectedAttributeValue> 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.

expressionAttributeNames

Map<String,String> 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<String, AttributeValue> 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.

key

Map<String, AttributeValue> 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.

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.

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.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

tableName

String tableName

The name of the table from which to delete the item.

Class com.amazonaws.services.dynamodbv2.model.DeleteItemResult

class DeleteItemResult extends Object implements Serializable

Serialized Fields

attributes

Map<String, AttributeValue> 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

class DeleteRequest extends Object implements Serializable

Serialized Fields

key

Map<String, AttributeValue> 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

class DeleteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table to delete.

Class com.amazonaws.services.dynamodbv2.model.DeleteTableResult

class DeleteTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsRequest

class DescribeLimitsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.dynamodbv2.model.DescribeLimitsResult

class 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

class DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

limit

Integer limit

The maximum number of shard objects to return. The upper limit is 100.

streamArn

String streamArn

The Amazon Resource Name (ARN) for the stream.

Class com.amazonaws.services.dynamodbv2.model.DescribeStreamResult

class 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

class DescribeTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

tableName

String tableName

The name of the table to describe.

Class com.amazonaws.services.dynamodbv2.model.DescribeTableResult

class DescribeTableResult extends Object implements Serializable

Serialized Fields

table

TableDescription table

Class com.amazonaws.services.dynamodbv2.model.ExpectedAttributeValue

class ExpectedAttributeValue extends Object implements Serializable

Serialized Fields

attributeValueList

List<AttributeValue> 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.

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"]}

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

value

AttributeValue value

Exception Class com.amazonaws.services.dynamodbv2.model.ExpiredIteratorException

class ExpiredIteratorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.GetItemRequest

class GetItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

List<String> 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.

expressionAttributeNames

Map<String,String> 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.

key

Map<String, AttributeValue> 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.

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.

returnConsumedCapacity

String returnConsumedCapacity

tableName

String tableName

The name of the table containing the requested item.

Class com.amazonaws.services.dynamodbv2.model.GetItemResult

class GetItemResult extends Object implements Serializable

Serialized Fields

consumedCapacity

ConsumedCapacity consumedCapacity

item

Map<String, AttributeValue> item

A map of attribute names to AttributeValue objects, as specified by AttributesToGet.

Class com.amazonaws.services.dynamodbv2.model.GetRecordsRequest

class GetRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

limit

Integer limit

The maximum number of records to return from the shard. The upper limit is 1000.

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.

Class com.amazonaws.services.dynamodbv2.model.GetRecordsResult

class GetRecordsResult extends Object implements Serializable

Serialized Fields

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.

records

List<Record> records

The stream records from the shard, which were retrieved using the shard iterator.

Class com.amazonaws.services.dynamodbv2.model.GetShardIteratorRequest

class GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sequenceNumber

String sequenceNumber

The sequence number of a stream record in the shard from which to start reading.

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.

streamArn

String streamArn

The Amazon Resource Name (ARN) for the stream.

Class com.amazonaws.services.dynamodbv2.model.GetShardIteratorResult

class 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

class 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<KeySchemaElement> 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

class GlobalSecondaryIndexDescription extends Object implements Serializable

Serialized Fields

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.

indexArn

String indexArn

The Amazon Resource Name (ARN) that uniquely identifies the index.

indexName

String indexName

The name of the global secondary index.

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.

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.

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.

keySchema

List<KeySchemaElement> 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

ProvisionedThroughputDescription provisionedThroughput

Class com.amazonaws.services.dynamodbv2.model.GlobalSecondaryIndexUpdate

class GlobalSecondaryIndexUpdate extends Object implements Serializable

Serialized Fields

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.

update

UpdateGlobalSecondaryIndexAction update

The name of an existing global secondary index, along with new provisioned throughput settings to be applied to that index.

Exception Class com.amazonaws.services.dynamodbv2.model.InternalServerErrorException

class InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ItemCollectionMetrics

class ItemCollectionMetrics extends Object implements Serializable

Serialized Fields

itemCollectionKey

Map<String, AttributeValue> itemCollectionKey

The partition key value of the item collection. This value is the same as the partition key value of the item.

sizeEstimateRangeGB

List<Double> 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.

Exception Class com.amazonaws.services.dynamodbv2.model.ItemCollectionSizeLimitExceededException

class ItemCollectionSizeLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.KeysAndAttributes

class KeysAndAttributes extends Object implements Serializable

Serialized Fields

attributesToGet

List<String> 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.

expressionAttributeNames

Map<String,String> 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.

keys

List<Map<String, AttributeValue>> keys

The primary key attribute values that define the items and the attributes associated with the items.

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.

Class com.amazonaws.services.dynamodbv2.model.KeySchemaElement

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

Exception Class com.amazonaws.services.dynamodbv2.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ListStreamsRequest

class ListStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

limit

Integer limit

The maximum number of streams to return. The upper limit is 100.

tableName

String tableName

If this parameter is provided, then only the streams associated with this table name are returned.

Class com.amazonaws.services.dynamodbv2.model.ListStreamsResult

class ListStreamsResult extends Object implements Serializable

Serialized Fields

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.

streams

List<Stream> streams

A list of stream descriptors associated with the current account and endpoint.

Class com.amazonaws.services.dynamodbv2.model.ListTablesRequest

class 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

class ListTablesResult extends Object implements Serializable

Serialized Fields

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.

tableNames

List<String> 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.

Class com.amazonaws.services.dynamodbv2.model.LocalSecondaryIndex

class 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<KeySchemaElement> 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

class LocalSecondaryIndexDescription extends Object implements Serializable

Serialized Fields

indexArn

String indexArn

The Amazon Resource Name (ARN) that uniquely identifies the index.

indexName

String indexName

Represents the name of the local secondary index.

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.

keySchema

List<KeySchemaElement> 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.Projection

class Projection extends Object implements Serializable

Serialized Fields

nonKeyAttributes

List<String> 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.

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.

Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughput

class 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

class ProvisionedThroughputDescription extends Object implements Serializable

Serialized Fields

lastDecreaseDateTime

Date lastDecreaseDateTime

The date and time of the last provisioned throughput decrease for this table.

lastIncreaseDateTime

Date lastIncreaseDateTime

The date and time of the last provisioned throughput increase 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.

Exception Class com.amazonaws.services.dynamodbv2.model.ProvisionedThroughputExceededException

class ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.PutItemRequest

class PutItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

expected

Map<String, ExpectedAttributeValue> 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.

expressionAttributeNames

Map<String,String> 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<String, AttributeValue> 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.

item

Map<String, AttributeValue> 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.

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.

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.

The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

tableName

String tableName

The name of the table to contain the item.

Class com.amazonaws.services.dynamodbv2.model.PutItemResult

class PutItemResult extends Object implements Serializable

Serialized Fields

attributes

Map<String, AttributeValue> 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

class PutRequest extends Object implements Serializable

Serialized Fields

item

Map<String, AttributeValue> 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

class QueryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

List<String> 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.

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.

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.

exclusiveStartKey

Map<String, AttributeValue> 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.

expressionAttributeNames

Map<String,String> 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<String, AttributeValue> 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.

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.

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.

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.

keyConditions

Map<String, Condition> 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.

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.

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.

queryFilter

Map<String, Condition> 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.

returnConsumedCapacity

String returnConsumedCapacity

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.

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.

tableName

String tableName

The name of the table containing the requested items.

Class com.amazonaws.services.dynamodbv2.model.QueryResult

class QueryResult extends Object implements Serializable

Serialized Fields

consumedCapacity

ConsumedCapacity consumedCapacity

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.

items

List<Map<String, AttributeValue>> 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.

lastEvaluatedKey

Map<String, AttributeValue> 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.

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.

Class com.amazonaws.services.dynamodbv2.model.Record

class Record extends Object implements Serializable

Serialized Fields

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.

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

eventSource

String eventSource

The AWS service from which the stream record originated. For DynamoDB Streams, this is aws:dynamodb.

eventVersion

String eventVersion

The version number of the stream record format. Currently, this is 1.0.

Exception Class com.amazonaws.services.dynamodbv2.model.ResourceInUseException

class ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.dynamodbv2.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.ScanRequest

class ScanRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributesToGet

List<String> 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.

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.

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.

exclusiveStartKey

Map<String, AttributeValue> 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.

expressionAttributeNames

Map<String,String> 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<String, AttributeValue> 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.

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.

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.

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.

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.

returnConsumedCapacity

String returnConsumedCapacity

scanFilter

Map<String, Condition> 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.

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.

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.

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

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.

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.

Class com.amazonaws.services.dynamodbv2.model.ScanResult

class ScanResult extends Object implements Serializable

Serialized Fields

consumedCapacity

ConsumedCapacity consumedCapacity

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.

items

List<Map<String, AttributeValue>> 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.

lastEvaluatedKey

Map<String, AttributeValue> 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.

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.

Class com.amazonaws.services.dynamodbv2.model.SequenceNumberRange

class SequenceNumberRange extends Object implements Serializable

Serialized Fields

endingSequenceNumber

String endingSequenceNumber

The last sequence number.

startingSequenceNumber

String startingSequenceNumber

The first sequence number.

Class com.amazonaws.services.dynamodbv2.model.Shard

class Shard extends Object implements Serializable

Serialized Fields

parentShardId

String parentShardId

The shard ID of the current shard's parent.

sequenceNumberRange

SequenceNumberRange sequenceNumberRange

The range of possible sequence numbers for the shard.

shardId

String shardId

The system-generated identifier for this shard.

Class com.amazonaws.services.dynamodbv2.model.Stream

class Stream 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

tableName

String tableName

The DynamoDB table with which the stream is associated.

Class com.amazonaws.services.dynamodbv2.model.StreamDescription

class StreamDescription extends Object implements Serializable

Serialized Fields

creationRequestDateTime

Date creationRequestDateTime

The date and time when the request to create this stream was issued.

keySchema

List<KeySchemaElement> keySchema

The key attribute(s) of the stream's DynamoDB table.

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.

shards

List<Shard> shards

The shards that comprise the stream.

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.

tableName

String tableName

The DynamoDB table with which the stream is associated.

Class com.amazonaws.services.dynamodbv2.model.StreamRecord

class StreamRecord extends Object implements Serializable

Serialized Fields

keys

Map<String, AttributeValue> keys

The primary key attribute(s) for the DynamoDB item that was modified.

newImage

Map<String, AttributeValue> newImage

The item in the DynamoDB table as it appeared after it was modified.

oldImage

Map<String, AttributeValue> 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

class 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

class TableDescription extends Object implements Serializable

Serialized Fields

attributeDefinitions

List<AttributeDefinition> 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.

creationDateTime

Date creationDateTime

The date and time when the table was created, in UNIX epoch time format.

globalSecondaryIndexes

List<GlobalSecondaryIndexDescription> 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.

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.

keySchema

List<KeySchemaElement> 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.

latestStreamArn

String latestStreamArn

The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this 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.

localSecondaryIndexes

List<LocalSecondaryIndexDescription> 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.

provisionedThroughput

ProvisionedThroughputDescription provisionedThroughput

The provisioned throughput settings for the table, consisting of read and write capacity units, along with data about increases and decreases.

streamSpecification

StreamSpecification streamSpecification

The current DynamoDB Streams configuration for the table.

tableArn

String tableArn

The Amazon Resource Name (ARN) that uniquely identifies the table.

tableName

String tableName

The name of the table.

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.

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.

Exception Class com.amazonaws.services.dynamodbv2.model.TrimmedDataAccessException

class TrimmedDataAccessException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.dynamodbv2.model.UpdateGlobalSecondaryIndexAction

class 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

class UpdateItemRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeUpdates

Map<String, AttributeValueUpdate> 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.

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

expected

Map<String, ExpectedAttributeValue> 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.

expressionAttributeNames

Map<String,String> 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<String, AttributeValue> 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.

key

Map<String, AttributeValue> 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.

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.

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

tableName

String tableName

The name of the table containing the item to update.

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.

Class com.amazonaws.services.dynamodbv2.model.UpdateItemResult

class UpdateItemResult extends Object implements Serializable

Serialized Fields

attributes

Map<String, AttributeValue> 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

class UpdateTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeDefinitions

List<AttributeDefinition> 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.

globalSecondaryIndexUpdates

List<GlobalSecondaryIndexUpdate> 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.

provisionedThroughput

ProvisionedThroughput provisionedThroughput

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.

tableName

String tableName

The name of the table to be updated.

Class com.amazonaws.services.dynamodbv2.model.UpdateTableResult

class UpdateTableResult extends Object implements Serializable

Serialized Fields

tableDescription

TableDescription tableDescription

Class com.amazonaws.services.dynamodbv2.model.WriteRequest

class WriteRequest extends Object implements Serializable

Serialized Fields

deleteRequest

DeleteRequest deleteRequest

A request to perform a DeleteItem operation.

putRequest

PutRequest putRequest

A request to perform a PutItem operation.

Package com.amazonaws.services.dynamodbv2.util

Exception Class com.amazonaws.services.dynamodbv2.util.TableUtils.TableNeverTransitionedToStateException

class TableNeverTransitionedToStateException extends AmazonClientException implements Serializable

serialVersionUID:

8920567021104846647L

Package com.amazonaws.services.ec2.model

Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionRequest

class AcceptVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.AcceptVpcPeeringConnectionResult

class AcceptVpcPeeringConnectionResult extends Object implements Serializable

Serialized Fields

vpcPeeringConnection

VpcPeeringConnection vpcPeeringConnection

Information about the VPC peering connection.

Class com.amazonaws.services.ec2.model.AccountAttribute

class AccountAttribute extends Object implements Serializable

Serialized Fields

attributeName

String attributeName

The name of the account attribute.

attributeValues

com.amazonaws.internal.SdkInternalList<AccountAttributeValue> attributeValues

One or more values for the account attribute.

Class com.amazonaws.services.ec2.model.AccountAttributeValue

class AccountAttributeValue extends Object implements Serializable

Serialized Fields

attributeValue

String attributeValue

The value of the attribute.

Class com.amazonaws.services.ec2.model.ActiveInstance

class ActiveInstance extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance.

instanceType

String instanceType

The instance type.

spotInstanceRequestId

String spotInstanceRequestId

The ID of the Spot instance request.

Class com.amazonaws.services.ec2.model.Address

class Address extends Object implements Serializable

Serialized Fields

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

instanceId

String instanceId

The ID of the instance that the address is associated with (if any).

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.

publicIp

String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.AllocateAddressRequest

class 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

class AllocateAddressResult extends Object implements Serializable

Serialized Fields

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.

domain

String domain

Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or instances in a VPC ( vpc).

publicIp

String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.AllocateHostsRequest

class 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

availabilityZone

String availabilityZone

The Availability Zone for the Dedicated hosts.

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.

Class com.amazonaws.services.ec2.model.AllocateHostsResult

class AllocateHostsResult extends Object implements Serializable

Serialized Fields

hostIds

com.amazonaws.internal.SdkInternalList<String> 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

class AssignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

privateIpAddresses

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.ec2.model.AssignPrivateIpAddressesResult

class AssignPrivateIpAddressesResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.AssociateAddressRequest

class AssociateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocationId

String allocationId

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

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.

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.

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.

publicIp

String publicIp

The Elastic IP address. This is required for EC2-Classic.

Class com.amazonaws.services.ec2.model.AssociateAddressResult

class 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

class 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.AssociateDhcpOptionsResult

class AssociateDhcpOptionsResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.AssociateRouteTableRequest

class AssociateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

The ID of the route table.

subnetId

String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.AssociateRouteTableResult

class 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

class AttachClassicLinkVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groups

com.amazonaws.internal.SdkInternalList<String> groups

The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.

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.

Class com.amazonaws.services.ec2.model.AttachClassicLinkVpcResult

class 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

class 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.AttachInternetGatewayResult

class AttachInternetGatewayResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceRequest

class AttachNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deviceIndex

Integer deviceIndex

The index of the device for the network interface attachment.

instanceId

String instanceId

The ID of the instance.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

Class com.amazonaws.services.ec2.model.AttachNetworkInterfaceResult

class AttachNetworkInterfaceResult extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

The ID of the network interface attachment.

Class com.amazonaws.services.ec2.model.AttachVolumeRequest

class AttachVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

device

String device

The device name to expose to the instance (for example, /dev/sdh or xvdh).

instanceId

String instanceId

The ID of the instance.

volumeId

String volumeId

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

Class com.amazonaws.services.ec2.model.AttachVolumeResult

class AttachVolumeResult extends Object implements Serializable

Serialized Fields

attachment

VolumeAttachment attachment

Describes volume attachment details.

Class com.amazonaws.services.ec2.model.AttachVpnGatewayRequest

class AttachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

vpnGatewayId

String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.AttachVpnGatewayResult

class AttachVpnGatewayResult extends Object implements Serializable

Serialized Fields

vpcAttachment

VpcAttachment vpcAttachment

Information about the attachment.

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressRequest

class AuthorizeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

String cidrIp

The CIDR IP address range. We recommend that you specify the CIDR range 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.

groupId

String groupId

The ID of the security group.

ipPermissions

com.amazonaws.internal.SdkInternalList<IpPermission> ipPermissions

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

ipProtocol

String ipProtocol

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

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.

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.

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupEgressResult

class AuthorizeSecurityGroupEgressResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressRequest

class AuthorizeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

String cidrIp

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

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.

groupId

String groupId

The ID of the security group. Required for a nondefault VPC.

groupName

String groupName

[EC2-Classic, default VPC] The name of the security group.

ipPermissions

com.amazonaws.internal.SdkInternalList<IpPermission> ipPermissions

A set of IP permissions. Can be used to specify multiple rules in a single command.

ipProtocol

String ipProtocol

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). (VPC only) Use -1 to specify all.

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.

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.

Class com.amazonaws.services.ec2.model.AuthorizeSecurityGroupIngressResult

class AuthorizeSecurityGroupIngressResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.AvailabilityZone

class AvailabilityZone extends Object implements Serializable

Serialized Fields

messages

com.amazonaws.internal.SdkInternalList<AvailabilityZoneMessage> messages

Any messages about the Availability Zone.

regionName

String regionName

The name of the region.

state

String state

The state of the Availability Zone.

zoneName

String zoneName

The name of the Availability Zone.

Class com.amazonaws.services.ec2.model.AvailabilityZoneMessage

class AvailabilityZoneMessage extends Object implements Serializable

Serialized Fields

message

String message

The message about the Availability Zone.

Class com.amazonaws.services.ec2.model.AvailableCapacity

class AvailableCapacity extends Object implements Serializable

Serialized Fields

availableInstanceCapacity

com.amazonaws.internal.SdkInternalList<InstanceCapacity> 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

class BlockDeviceMapping extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.ec2.model.BundleInstanceRequest

class 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

class BundleInstanceResult extends Object implements Serializable

Serialized Fields

bundleTask

BundleTask bundleTask

Information about the bundle task.

Class com.amazonaws.services.ec2.model.BundleTask

class BundleTask extends Object implements Serializable

Serialized Fields

bundleId

String bundleId

The ID of the bundle task.

bundleTaskError

BundleTaskError bundleTaskError

If the task fails, a description of the error.

instanceId

String instanceId

The ID of the instance associated with this bundle task.

progress

String progress

The level of task completion, as a percent (for example, 20%).

startTime

Date startTime

The time this task started.

state

String state

The state of the task.

storage

Storage storage

The Amazon S3 storage locations.

updateTime

Date updateTime

The time of the most recent update for the task.

Class com.amazonaws.services.ec2.model.BundleTaskError

class 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

class CancelBundleTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bundleId

String bundleId

The ID of the bundle task.

Class com.amazonaws.services.ec2.model.CancelBundleTaskResult

class CancelBundleTaskResult extends Object implements Serializable

Serialized Fields

bundleTask

BundleTask bundleTask

Information about the bundle task.

Class com.amazonaws.services.ec2.model.CancelConversionTaskRequest

class 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.CancelConversionTaskResult

class CancelConversionTaskResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.CancelExportTaskRequest

class 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.CancelExportTaskResult

class CancelExportTaskResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.CancelImportTaskRequest

class CancelImportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cancelReason

String cancelReason

The reason for canceling the task.

importTaskId

String importTaskId

The ID of the import image or import snapshot task to be canceled.

Class com.amazonaws.services.ec2.model.CancelImportTaskResult

class CancelImportTaskResult extends Object implements Serializable

Serialized Fields

importTaskId

String importTaskId

The ID of the task being canceled.

previousState

String previousState

The current state of the task being canceled.

state

String state

The current state of the task being canceled.

Class com.amazonaws.services.ec2.model.CancelledSpotInstanceRequest

class 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

class CancelReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

reservedInstancesListingId

String reservedInstancesListingId

The ID of the Reserved Instance listing.

Class com.amazonaws.services.ec2.model.CancelReservedInstancesListingResult

class CancelReservedInstancesListingResult extends Object implements Serializable

Serialized Fields

reservedInstancesListings

com.amazonaws.internal.SdkInternalList<ReservedInstancesListing> reservedInstancesListings

The Reserved Instance listing.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsError

class 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

class CancelSpotFleetRequestsErrorItem extends Object implements Serializable

Serialized Fields

error

CancelSpotFleetRequestsError error

The error.

spotFleetRequestId

String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsRequest

class CancelSpotFleetRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotFleetRequestIds

com.amazonaws.internal.SdkInternalList<String> 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

class CancelSpotFleetRequestsResult extends Object implements Serializable

Serialized Fields

successfulFleetRequests

com.amazonaws.internal.SdkInternalList<CancelSpotFleetRequestsSuccessItem> successfulFleetRequests

Information about the Spot fleet requests that are successfully canceled.

unsuccessfulFleetRequests

com.amazonaws.internal.SdkInternalList<CancelSpotFleetRequestsErrorItem> unsuccessfulFleetRequests

Information about the Spot fleet requests that are not successfully canceled.

Class com.amazonaws.services.ec2.model.CancelSpotFleetRequestsSuccessItem

class CancelSpotFleetRequestsSuccessItem extends Object implements Serializable

Serialized Fields

currentSpotFleetRequestState

String currentSpotFleetRequestState

The current state of the Spot fleet request.

previousSpotFleetRequestState

String previousSpotFleetRequestState

The previous state of the Spot fleet request.

spotFleetRequestId

String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsRequest

class CancelSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotInstanceRequestIds

com.amazonaws.internal.SdkInternalList<String> spotInstanceRequestIds

One or more Spot instance request IDs.

Class com.amazonaws.services.ec2.model.CancelSpotInstanceRequestsResult

class CancelSpotInstanceRequestsResult extends Object implements Serializable

Serialized Fields

cancelledSpotInstanceRequests

com.amazonaws.internal.SdkInternalList<CancelledSpotInstanceRequest> cancelledSpotInstanceRequests

One or more Spot instance requests.

Class com.amazonaws.services.ec2.model.ClassicLinkDnsSupport

class ClassicLinkDnsSupport extends Object implements Serializable

Serialized Fields

classicLinkDnsSupported

Boolean classicLinkDnsSupported

Indicates whether ClassicLink DNS support is enabled for the VPC.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.ClassicLinkInstance

class ClassicLinkInstance extends Object implements Serializable

Serialized Fields

groups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> groups

A list of security groups.

instanceId

String instanceId

The ID of the instance.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the instance.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.ClientData

class ClientData extends Object implements Serializable

Serialized Fields

comment

String comment

A user-defined comment about the disk upload.

uploadEnd

Date uploadEnd

The time that the disk upload ends.

uploadSize

Double uploadSize

The size of the uploaded disk image, in GiB.

uploadStart

Date uploadStart

The time that the disk upload starts.

Class com.amazonaws.services.ec2.model.ConfirmProductInstanceRequest

class ConfirmProductInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance.

productCode

String productCode

The product code. This must be a product code that you own.

Class com.amazonaws.services.ec2.model.ConfirmProductInstanceResult

class 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

class 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<Tag> tags

Any tags assigned to the task.

Class com.amazonaws.services.ec2.model.CopyImageRequest

class CopyImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

description

String description

A description for the new AMI in the destination region.

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.

name

String name

The name of the new AMI in the destination region.

sourceImageId

String sourceImageId

The ID of the AMI to copy.

sourceRegion

String sourceRegion

The name of the region that contains the AMI to copy.

Class com.amazonaws.services.ec2.model.CopyImageResult

class CopyImageResult extends Object implements Serializable

Serialized Fields

imageId

String imageId

The ID of the new AMI.

Class com.amazonaws.services.ec2.model.CopySnapshotRequest

class CopySnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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.

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.

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.

Class com.amazonaws.services.ec2.model.CopySnapshotResult

class CopySnapshotResult extends Object implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the new snapshot.

Class com.amazonaws.services.ec2.model.CreateCustomerGatewayRequest

class CreateCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bgpAsn

Integer bgpAsn

For devices that support BGP, the customer gateway's BGP ASN.

Default: 65000

publicIp

String publicIp

The Internet-routable IP address for the customer gateway's outside interface. The address must be static.

type

String type

The type of VPN connection that this customer gateway supports ( ipsec.1).

Class com.amazonaws.services.ec2.model.CreateCustomerGatewayResult

class CreateCustomerGatewayResult extends Object implements Serializable

Serialized Fields

customerGateway

CustomerGateway customerGateway

Information about the customer gateway.

Class com.amazonaws.services.ec2.model.CreateDhcpOptionsRequest

class CreateDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpConfigurations

com.amazonaws.internal.SdkInternalList<DhcpConfiguration> dhcpConfigurations

A DHCP configuration option.

Class com.amazonaws.services.ec2.model.CreateDhcpOptionsResult

class CreateDhcpOptionsResult extends Object implements Serializable

Serialized Fields

dhcpOptions

DhcpOptions dhcpOptions

A set of DHCP options.

Class com.amazonaws.services.ec2.model.CreateFlowLogsRequest

class CreateFlowLogsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

deliverLogsPermissionArn

String deliverLogsPermissionArn

The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group.

logGroupName

String logGroupName

The name of the CloudWatch log group.

resourceIds

com.amazonaws.internal.SdkInternalList<String> resourceIds

One or more subnet, network interface, or VPC IDs.

Constraints: Maximum of 1000 resources

resourceType

String resourceType

The type of resource on which to create the flow log.

trafficType

String trafficType

The type of traffic to log.

Class com.amazonaws.services.ec2.model.CreateFlowLogsResult

class CreateFlowLogsResult extends Object implements Serializable

Serialized Fields

clientToken

String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

flowLogIds

com.amazonaws.internal.SdkInternalList<String> flowLogIds

The IDs of the flow logs.

unsuccessful

com.amazonaws.internal.SdkInternalList<UnsuccessfulItem> unsuccessful

Information about the flow logs that could not be created successfully.

Class com.amazonaws.services.ec2.model.CreateImageRequest

class CreateImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> blockDeviceMappings

Information about one or more block device mappings.

description

String description

A description for the new image.

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(_)

noReboot

Boolean noReboot

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, 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.

Class com.amazonaws.services.ec2.model.CreateImageResult

class CreateImageResult extends Object implements Serializable

Serialized Fields

imageId

String imageId

The ID of the new AMI.

Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskRequest

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

exportToS3Task

ExportToS3TaskSpecification exportToS3Task

The format and location for an instance export task.

instanceId

String instanceId

The ID of the instance.

targetEnvironment

String targetEnvironment

The target virtualization environment.

Class com.amazonaws.services.ec2.model.CreateInstanceExportTaskResult

class CreateInstanceExportTaskResult extends Object implements Serializable

Serialized Fields

exportTask

ExportTask exportTask

Information about the instance export task.

Class com.amazonaws.services.ec2.model.CreateInternetGatewayRequest

class CreateInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.CreateInternetGatewayResult

class CreateInternetGatewayResult extends Object implements Serializable

Serialized Fields

internetGateway

InternetGateway internetGateway

Information about the Internet gateway.

Class com.amazonaws.services.ec2.model.CreateKeyPairRequest

class 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

class CreateKeyPairResult extends Object implements Serializable

Serialized Fields

keyPair

KeyPair keyPair

Describes a key pair.

Class com.amazonaws.services.ec2.model.CreateNatGatewayRequest

class CreateNatGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

subnetId

String subnetId

The subnet in which to create the NAT gateway.

Class com.amazonaws.services.ec2.model.CreateNatGatewayResult

class CreateNatGatewayResult extends Object implements Serializable

Serialized Fields

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.

natGateway

NatGateway natGateway

Information about the NAT gateway.

Class com.amazonaws.services.ec2.model.CreateNetworkAclEntryRequest

class CreateNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrBlock

String cidrBlock

The network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

egress

Boolean egress

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

icmpTypeCode

IcmpTypeCode icmpTypeCode

ICMP protocol: The ICMP type and code. Required if specifying ICMP for the protocol.

networkAclId

String networkAclId

The ID of the network ACL.

portRange

PortRange portRange

TCP or UDP protocols: The range of ports the rule applies to.

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.

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

Class com.amazonaws.services.ec2.model.CreateNetworkAclEntryResult

class CreateNetworkAclEntryResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.CreateNetworkAclRequest

class CreateNetworkAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.CreateNetworkAclResult

class CreateNetworkAclResult extends Object implements Serializable

Serialized Fields

networkAcl

NetworkAcl networkAcl

Information about the network ACL.

Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceRequest

class CreateNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

A description for the network interface.

groups

com.amazonaws.internal.SdkInternalList<String> groups

The IDs of one or more security groups.

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

privateIpAddresses

com.amazonaws.internal.SdkInternalList<PrivateIpAddressSpecification> 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.

subnetId

String subnetId

The ID of the subnet to associate with the network interface.

Class com.amazonaws.services.ec2.model.CreateNetworkInterfaceResult

class CreateNetworkInterfaceResult extends Object implements Serializable

Serialized Fields

networkInterface

NetworkInterface networkInterface

Information about the network interface.

Class com.amazonaws.services.ec2.model.CreatePlacementGroupRequest

class 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.CreatePlacementGroupResult

class CreatePlacementGroupResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingRequest

class CreateReservedInstancesListingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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<PriceScheduleSpecification> priceSchedules

A list specifying the price of the Reserved Instance for each month remaining in the Reserved Instance term.

reservedInstancesId

String reservedInstancesId

The ID of the active Reserved Instance.

Class com.amazonaws.services.ec2.model.CreateReservedInstancesListingResult

class CreateReservedInstancesListingResult extends Object implements Serializable

Serialized Fields

reservedInstancesListings

com.amazonaws.internal.SdkInternalList<ReservedInstancesListing> reservedInstancesListings

Information about the Reserved Instance listing.

Class com.amazonaws.services.ec2.model.CreateRouteRequest

class CreateRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

natGatewayId

String natGatewayId

The ID of a NAT gateway.

networkInterfaceId

String networkInterfaceId

The ID of a network interface.

routeTableId

String routeTableId

The ID of the route table for the route.

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of a VPC peering connection.

Class com.amazonaws.services.ec2.model.CreateRouteResult

class 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

class CreateRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.CreateRouteTableResult

class CreateRouteTableResult extends Object implements Serializable

Serialized Fields

routeTable

RouteTable routeTable

Information about the route table.

Class com.amazonaws.services.ec2.model.CreateSecurityGroupRequest

class CreateSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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 ._-:/()#,@[]+=;{}!$*

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 ._-:/()#,@[]+=;{}!$*

vpcId

String vpcId

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

Class com.amazonaws.services.ec2.model.CreateSecurityGroupResult

class CreateSecurityGroupResult extends Object implements Serializable

Serialized Fields

groupId

String groupId

The ID of the security group.

Class com.amazonaws.services.ec2.model.CreateSnapshotRequest

class CreateSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

A description for the snapshot.

volumeId

String volumeId

The ID of the EBS volume.

Class com.amazonaws.services.ec2.model.CreateSnapshotResult

class CreateSnapshotResult extends Object implements Serializable

Serialized Fields

snapshot

Snapshot snapshot

Describes a snapshot.

Class com.amazonaws.services.ec2.model.CreateSpotDatafeedSubscriptionRequest

class 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

class CreateSpotDatafeedSubscriptionResult extends Object implements Serializable

Serialized Fields

spotDatafeedSubscription

SpotDatafeedSubscription spotDatafeedSubscription

The Spot instance data feed subscription.

Class com.amazonaws.services.ec2.model.CreateSubnetRequest

class CreateSubnetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

cidrBlock

String cidrBlock

The network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.CreateSubnetResult

class CreateSubnetResult extends Object implements Serializable

Serialized Fields

subnet

Subnet subnet

Information about the subnet.

Class com.amazonaws.services.ec2.model.CreateTagsRequest

class CreateTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resources

com.amazonaws.internal.SdkInternalList<String> resources

The IDs of one or more resources to tag. For example, ami-1a2b3c4d.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.CreateTagsResult

class CreateTagsResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.CreateVolumePermission

class CreateVolumePermission extends Object implements Serializable

Serialized Fields

group

String group

The specific group that is to be added or removed from a volume's list of create volume permissions.

userId

String userId

The specific AWS account ID that is to be added or removed from a volume's list of create volume permissions.

Class com.amazonaws.services.ec2.model.CreateVolumePermissionModifications

class CreateVolumePermissionModifications extends Object implements Serializable

Serialized Fields

add

com.amazonaws.internal.SdkInternalList<CreateVolumePermission> add

Adds a specific AWS account ID or group to a volume's list of create volume permissions.

remove

com.amazonaws.internal.SdkInternalList<CreateVolumePermission> 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

class CreateVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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

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.

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.

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

Class com.amazonaws.services.ec2.model.CreateVolumeResult

class CreateVolumeResult extends Object implements Serializable

Serialized Fields

volume

Volume volume

Describes a volume.

Class com.amazonaws.services.ec2.model.CreateVpcEndpointRequest

class CreateVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

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<String> routeTableIds

One or more route table IDs.

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.

vpcId

String vpcId

The ID of the VPC in which the endpoint will be used.

Class com.amazonaws.services.ec2.model.CreateVpcEndpointResult

class CreateVpcEndpointResult extends Object implements Serializable

Serialized Fields

clientToken

String clientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request.

vpcEndpoint

VpcEndpoint vpcEndpoint

Information about the endpoint.

Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionRequest

class CreateVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

peerOwnerId

String peerOwnerId

The AWS account ID of the owner of the peer VPC.

Default: Your AWS account ID

peerVpcId

String peerVpcId

The ID of the VPC with which you are creating the VPC peering connection.

vpcId

String vpcId

The ID of the requester VPC.

Class com.amazonaws.services.ec2.model.CreateVpcPeeringConnectionResult

class CreateVpcPeeringConnectionResult extends Object implements Serializable

Serialized Fields

vpcPeeringConnection

VpcPeeringConnection vpcPeeringConnection

Information about the VPC peering connection.

Class com.amazonaws.services.ec2.model.CreateVpcRequest

class 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 tenancy options for instances launched into the VPC. For default, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated or host into a dedicated tenancy VPC.

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

class CreateVpcResult extends Object implements Serializable

Serialized Fields

vpc

Vpc vpc

Information about the VPC.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionRequest

class CreateVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayId

String customerGatewayId

The ID of the customer 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

type

String type

The type of VPN connection (ipsec.1).

vpnGatewayId

String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionResult

class CreateVpnConnectionResult extends Object implements Serializable

Serialized Fields

vpnConnection

VpnConnection vpnConnection

Information about the VPN connection.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionRouteRequest

class CreateVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

String destinationCidrBlock

The CIDR block associated with the local subnet of the customer network.

vpnConnectionId

String vpnConnectionId

The ID of the VPN connection.

Class com.amazonaws.services.ec2.model.CreateVpnConnectionRouteResult

class CreateVpnConnectionRouteResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.CreateVpnGatewayRequest

class CreateVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone for the virtual private gateway.

type

String type

The type of VPN connection this virtual private gateway supports.

Class com.amazonaws.services.ec2.model.CreateVpnGatewayResult

class CreateVpnGatewayResult extends Object implements Serializable

Serialized Fields

vpnGateway

VpnGateway vpnGateway

Information about the virtual private gateway.

Class com.amazonaws.services.ec2.model.CustomerGateway

class CustomerGateway extends Object implements Serializable

Serialized Fields

bgpAsn

String bgpAsn

The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).

customerGatewayId

String customerGatewayId

The ID of the customer gateway.

ipAddress

String ipAddress

The Internet-routable IP address of the customer gateway's outside interface.

state

String state

The current state of the customer gateway ( pending | available | deleting | deleted).

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the customer gateway.

type

String type

The type of VPN connection the customer gateway supports ( ipsec.1).

Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayRequest

class DeleteCustomerGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayId

String customerGatewayId

The ID of the customer gateway.

Class com.amazonaws.services.ec2.model.DeleteCustomerGatewayResult

class DeleteCustomerGatewayResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsRequest

class DeleteDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsId

String dhcpOptionsId

The ID of the DHCP options set.

Class com.amazonaws.services.ec2.model.DeleteDhcpOptionsResult

class DeleteDhcpOptionsResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteFlowLogsRequest

class DeleteFlowLogsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

flowLogIds

com.amazonaws.internal.SdkInternalList<String> flowLogIds

One or more flow log IDs.

Class com.amazonaws.services.ec2.model.DeleteFlowLogsResult

class DeleteFlowLogsResult extends Object implements Serializable

Serialized Fields

unsuccessful

com.amazonaws.internal.SdkInternalList<UnsuccessfulItem> unsuccessful

Information about the flow logs that could not be deleted successfully.

Class com.amazonaws.services.ec2.model.DeleteInternetGatewayRequest

class DeleteInternetGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

internetGatewayId

String internetGatewayId

The ID of the Internet gateway.

Class com.amazonaws.services.ec2.model.DeleteInternetGatewayResult

class DeleteInternetGatewayResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteKeyPairRequest

class DeleteKeyPairRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyName

String keyName

The name of the key pair.

Class com.amazonaws.services.ec2.model.DeleteKeyPairResult

class DeleteKeyPairResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteNatGatewayRequest

class DeleteNatGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

natGatewayId

String natGatewayId

The ID of the NAT gateway.

Class com.amazonaws.services.ec2.model.DeleteNatGatewayResult

class DeleteNatGatewayResult extends Object implements Serializable

Serialized Fields

natGatewayId

String natGatewayId

The ID of the NAT gateway.

Class com.amazonaws.services.ec2.model.DeleteNetworkAclEntryRequest

class DeleteNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

egress

Boolean egress

Indicates whether the rule is an egress rule.

networkAclId

String networkAclId

The ID of the network ACL.

ruleNumber

Integer ruleNumber

The rule number of the entry to delete.

Class com.amazonaws.services.ec2.model.DeleteNetworkAclEntryResult

class DeleteNetworkAclEntryResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteNetworkAclRequest

class DeleteNetworkAclRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkAclId

String networkAclId

The ID of the network ACL.

Class com.amazonaws.services.ec2.model.DeleteNetworkAclResult

class DeleteNetworkAclResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceRequest

class DeleteNetworkInterfaceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

Class com.amazonaws.services.ec2.model.DeleteNetworkInterfaceResult

class DeleteNetworkInterfaceResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeletePlacementGroupRequest

class DeletePlacementGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the placement group.

Class com.amazonaws.services.ec2.model.DeletePlacementGroupResult

class DeletePlacementGroupResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteRouteRequest

class DeleteRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

String destinationCidrBlock

The CIDR range for the route. The value you specify must match the CIDR for the route exactly.

routeTableId

String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.DeleteRouteResult

class DeleteRouteResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteRouteTableRequest

class DeleteRouteTableRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

routeTableId

String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.DeleteRouteTableResult

class DeleteRouteTableResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteSecurityGroupRequest

class DeleteSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupId

String groupId

The ID of the security group. Required for a nondefault VPC.

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.

Class com.amazonaws.services.ec2.model.DeleteSecurityGroupResult

class DeleteSecurityGroupResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteSnapshotRequest

class DeleteSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

snapshotId

String snapshotId

The ID of the EBS snapshot.

Class com.amazonaws.services.ec2.model.DeleteSnapshotResult

class DeleteSnapshotResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionRequest

class DeleteSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.DeleteSpotDatafeedSubscriptionResult

class DeleteSpotDatafeedSubscriptionResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteSubnetRequest

class DeleteSubnetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

subnetId

String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.DeleteSubnetResult

class DeleteSubnetResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteTagsRequest

class DeleteTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resources

com.amazonaws.internal.SdkInternalList<String> resources

The ID of the resource. For example, ami-1a2b3c4d. You can specify more than one resource ID.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.DeleteTagsResult

class DeleteTagsResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteVolumeRequest

class DeleteVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DeleteVolumeResult

class DeleteVolumeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsRequest

class DeleteVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcEndpointIds

com.amazonaws.internal.SdkInternalList<String> vpcEndpointIds

One or more endpoint IDs.

Class com.amazonaws.services.ec2.model.DeleteVpcEndpointsResult

class DeleteVpcEndpointsResult extends Object implements Serializable

Serialized Fields

unsuccessful

com.amazonaws.internal.SdkInternalList<UnsuccessfulItem> unsuccessful

Information about the endpoints that were not successfully deleted.

Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionRequest

class DeleteVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.DeleteVpcPeeringConnectionResult

class 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

class DeleteVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DeleteVpcResult

class DeleteVpcResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRequest

class DeleteVpnConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnConnectionId

String vpnConnectionId

The ID of the VPN connection.

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionResult

class DeleteVpnConnectionResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRouteRequest

class DeleteVpnConnectionRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationCidrBlock

String destinationCidrBlock

The CIDR block associated with the local subnet of the customer network.

vpnConnectionId

String vpnConnectionId

The ID of the VPN connection.

Class com.amazonaws.services.ec2.model.DeleteVpnConnectionRouteResult

class DeleteVpnConnectionRouteResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeleteVpnGatewayRequest

class DeleteVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpnGatewayId

String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.DeleteVpnGatewayResult

class DeleteVpnGatewayResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DeregisterImageRequest

class DeregisterImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageId

String imageId

The ID of the AMI.

Class com.amazonaws.services.ec2.model.DeregisterImageResult

class DeregisterImageResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DescribeAccountAttributesRequest

class DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

com.amazonaws.internal.SdkInternalList<String> attributeNames

One or more account attribute names.

Class com.amazonaws.services.ec2.model.DescribeAccountAttributesResult

class DescribeAccountAttributesResult extends Object implements Serializable

Serialized Fields

accountAttributes

com.amazonaws.internal.SdkInternalList<AccountAttribute> accountAttributes

Information about one or more account attributes.

Class com.amazonaws.services.ec2.model.DescribeAddressesRequest

class DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocationIds

com.amazonaws.internal.SdkInternalList<String> allocationIds

[EC2-VPC] One or more allocation IDs.

Default: Describes all your Elastic IP addresses.

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

publicIps

com.amazonaws.internal.SdkInternalList<String> publicIps

[EC2-Classic] One or more Elastic IP addresses.

Default: Describes all your Elastic IP addresses.

Class com.amazonaws.services.ec2.model.DescribeAddressesResult

class DescribeAddressesResult extends Object implements Serializable

Serialized Fields

addresses

com.amazonaws.internal.SdkInternalList<Address> addresses

Information about one or more Elastic IP addresses.

Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest

class DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

zoneNames

com.amazonaws.internal.SdkInternalList<String> zoneNames

The names of one or more Availability Zones.

Class com.amazonaws.services.ec2.model.DescribeAvailabilityZonesResult

class DescribeAvailabilityZonesResult extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<AvailabilityZone> availabilityZones

Information about one or more Availability Zones.

Class com.amazonaws.services.ec2.model.DescribeBundleTasksRequest

class DescribeBundleTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bundleIds

com.amazonaws.internal.SdkInternalList<String> bundleIds

One or more bundle task IDs.

Default: Describes all your bundle tasks.

filters

com.amazonaws.internal.SdkInternalList<Filter> 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

class DescribeBundleTasksResult extends Object implements Serializable

Serialized Fields

bundleTasks

com.amazonaws.internal.SdkInternalList<BundleTask> bundleTasks

Information about one or more bundle tasks.

Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesRequest

class DescribeClassicLinkInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs. Must be instances linked to a VPC through ClassicLink.

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.

nextToken

String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeClassicLinkInstancesResult

class DescribeClassicLinkInstancesResult extends Object implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<ClassicLinkInstance> 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

class DescribeConversionTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

conversionTaskIds

com.amazonaws.internal.SdkInternalList<String> conversionTaskIds

One or more conversion task IDs.

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

One or more filters.

Class com.amazonaws.services.ec2.model.DescribeConversionTasksResult

class DescribeConversionTasksResult extends Object implements Serializable

Serialized Fields

conversionTasks

com.amazonaws.internal.SdkInternalList<ConversionTask> conversionTasks

Information about the conversion tasks.

Class com.amazonaws.services.ec2.model.DescribeCustomerGatewaysRequest

class DescribeCustomerGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerGatewayIds

com.amazonaws.internal.SdkInternalList<String> customerGatewayIds

One or more customer gateway IDs.

Default: Describes all your customer gateways.

filters

com.amazonaws.internal.SdkInternalList<Filter> 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

class DescribeCustomerGatewaysResult extends Object implements Serializable

Serialized Fields

customerGateways

com.amazonaws.internal.SdkInternalList<CustomerGateway> customerGateways

Information about one or more customer gateways.

Class com.amazonaws.services.ec2.model.DescribeDhcpOptionsRequest

class DescribeDhcpOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dhcpOptionsIds

com.amazonaws.internal.SdkInternalList<String> dhcpOptionsIds

The IDs of one or more DHCP options sets.

Default: Describes all your DHCP options sets.

filters

com.amazonaws.internal.SdkInternalList<Filter> 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

class DescribeDhcpOptionsResult extends Object implements Serializable

Serialized Fields

dhcpOptions

com.amazonaws.internal.SdkInternalList<DhcpOptions> dhcpOptions

Information about one or more DHCP options sets.

Class com.amazonaws.services.ec2.model.DescribeExportTasksRequest

class DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exportTaskIds

com.amazonaws.internal.SdkInternalList<String> exportTaskIds

One or more export task IDs.

Class com.amazonaws.services.ec2.model.DescribeExportTasksResult

class DescribeExportTasksResult extends Object implements Serializable

Serialized Fields

exportTasks

com.amazonaws.internal.SdkInternalList<ExportTask> exportTasks

Information about the export tasks.

Class com.amazonaws.services.ec2.model.DescribeFlowLogsRequest

class DescribeFlowLogsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

com.amazonaws.internal.SdkInternalList<Filter> 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)

flowLogIds

com.amazonaws.internal.SdkInternalList<String> flowLogIds

One or more flow log IDs.

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.

nextToken

String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeFlowLogsResult

class DescribeFlowLogsResult extends Object implements Serializable

Serialized Fields

flowLogs

com.amazonaws.internal.SdkInternalList<FlowLog> 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

class DescribeHostsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

com.amazonaws.internal.SdkInternalList<Filter> 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.

hostIds

com.amazonaws.internal.SdkInternalList<String> hostIds

The IDs of the Dedicated hosts. The IDs are used for targeted instance launches.

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.

nextToken

String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeHostsResult

class DescribeHostsResult extends Object implements Serializable

Serialized Fields

hosts

com.amazonaws.internal.SdkInternalList<Host> 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

class DescribeIdFormatRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resource

String resource

The type of resource.

Class com.amazonaws.services.ec2.model.DescribeIdFormatResult

class DescribeIdFormatResult extends Object implements Serializable

Serialized Fields

statuses

com.amazonaws.internal.SdkInternalList<IdFormat> statuses

Information about the ID format for the resource.

Class com.amazonaws.services.ec2.model.DescribeImageAttributeRequest

class DescribeImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

imageId

String imageId

The ID of the AMI.

Class com.amazonaws.services.ec2.model.DescribeImageAttributeResult

class DescribeImageAttributeResult extends Object implements Serializable

Serialized Fields

imageAttribute

ImageAttribute imageAttribute

Describes an image attribute.

Class com.amazonaws.services.ec2.model.DescribeImagesRequest

class DescribeImagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

executableUsers

com.amazonaws.internal.SdkInternalList<String> 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<Filter> 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).

imageIds

com.amazonaws.internal.SdkInternalList<String> imageIds

One or more image IDs.

Default: Describes all images available to you.

owners

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.ec2.model.DescribeImagesResult

class DescribeImagesResult extends Object implements Serializable

Serialized Fields

images

com.amazonaws.internal.SdkInternalList<Image> images

Information about one or more images.

Class com.amazonaws.services.ec2.model.DescribeImportImageTasksRequest

class DescribeImportImageTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.

importTaskIds

com.amazonaws.internal.SdkInternalList<String> importTaskIds

A list of import image task IDs.

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.

nextToken

String nextToken

A token that indicates the next page of results.

Class com.amazonaws.services.ec2.model.DescribeImportImageTasksResult

class DescribeImportImageTasksResult extends Object implements Serializable

Serialized Fields

importImageTasks

com.amazonaws.internal.SdkInternalList<ImportImageTask> 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

class DescribeImportSnapshotTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

One or more filters.

importTaskIds

com.amazonaws.internal.SdkInternalList<String> importTaskIds

A list of import snapshot task IDs.

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.

nextToken

String nextToken

A token that indicates the next page of results.

Class com.amazonaws.services.ec2.model.DescribeImportSnapshotTasksResult

class DescribeImportSnapshotTasksResult extends Object implements Serializable

Serialized Fields

importSnapshotTasks

com.amazonaws.internal.SdkInternalList<ImportSnapshotTask> 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

class DescribeInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The instance attribute.

instanceId

String instanceId

The ID of the instance.

Class com.amazonaws.services.ec2.model.DescribeInstanceAttributeResult

class DescribeInstanceAttributeResult extends Object implements Serializable

Serialized Fields

instanceAttribute

InstanceAttribute instanceAttribute

Describes an instance attribute.

Class com.amazonaws.services.ec2.model.DescribeInstancesRequest

class DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Default: Describes all your instances.

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 or tag filters in the same call.

nextToken

String nextToken

The token to request the next page of results.

Class com.amazonaws.services.ec2.model.DescribeInstancesResult

class DescribeInstancesResult extends Object implements Serializable

Serialized Fields

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.

reservations

com.amazonaws.internal.SdkInternalList<Reservation> reservations

Zero or more reservations.

Class com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest

class DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

includeAllInstances

Boolean includeAllInstances

When true, includes the health status for all instances. When false, includes the health status for running instances only.

Default: false

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Default: Describes all your instances.

Constraints: Maximum 100 explicitly specified instance IDs.

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.

nextToken

String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeInstanceStatusResult

class DescribeInstanceStatusResult extends Object implements Serializable

Serialized Fields

instanceStatuses

com.amazonaws.internal.SdkInternalList<InstanceStatus> 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

class DescribeInternetGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

internetGatewayIds

com.amazonaws.internal.SdkInternalList<String> internetGatewayIds

One or more Internet gateway IDs.

Default: Describes all your Internet gateways.

Class com.amazonaws.services.ec2.model.DescribeInternetGatewaysResult

class DescribeInternetGatewaysResult extends Object implements Serializable

Serialized Fields

internetGateways

com.amazonaws.internal.SdkInternalList<InternetGateway> internetGateways

Information about one or more Internet gateways.

Class com.amazonaws.services.ec2.model.DescribeKeyPairsRequest

class DescribeKeyPairsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

One or more filters.

• fingerprint - The fingerprint of the key pair.

• key-name - The name of the key pair.

keyNames

com.amazonaws.internal.SdkInternalList<String> keyNames

One or more key pair names.

Default: Describes all your key pairs.

Class com.amazonaws.services.ec2.model.DescribeKeyPairsResult

class DescribeKeyPairsResult extends Object implements Serializable

Serialized Fields

keyPairs

com.amazonaws.internal.SdkInternalList<KeyPairInfo> keyPairs

Information about one or more key pairs.

Class com.amazonaws.services.ec2.model.DescribeMovingAddressesRequest

class DescribeMovingAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

nextToken

String nextToken

The token to use to retrieve the next page of results.

publicIps

com.amazonaws.internal.SdkInternalList<String> publicIps

One or more Elastic IP addresses.

Class com.amazonaws.services.ec2.model.DescribeMovingAddressesResult

class DescribeMovingAddressesResult extends Object implements Serializable

Serialized Fields

movingAddressStatuses

com.amazonaws.internal.SdkInternalList<MovingAddressStatus> 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

class DescribeNatGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

com.amazonaws.internal.SdkInternalList<Filter> 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.

natGatewayIds

com.amazonaws.internal.SdkInternalList<String> natGatewayIds

One or more NAT gateway IDs.

nextToken

String nextToken

The token to retrieve the next page of results.

Class com.amazonaws.services.ec2.model.DescribeNatGatewaysResult

class DescribeNatGatewaysResult extends Object implements Serializable

Serialized Fields

natGateways

com.amazonaws.internal.SdkInternalList<NatGateway> 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

class DescribeNetworkAclsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

networkAclIds

com.amazonaws.internal.SdkInternalList<String> networkAclIds

One or more network ACL IDs.

Default: Describes all your network ACLs.

Class com.amazonaws.services.ec2.model.DescribeNetworkAclsResult

class DescribeNetworkAclsResult extends Object implements Serializable

Serialized Fields

networkAcls

com.amazonaws.internal.SdkInternalList<NetworkAcl> networkAcls

Information about one or more network ACLs.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeRequest

class DescribeNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The attribute of the network interface.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfaceAttributeResult

class DescribeNetworkInterfaceAttributeResult extends Object implements Serializable

Serialized Fields

attachment

NetworkInterfaceAttachment attachment

The attachment (if any) of the network interface.

description

String description

The description of the network interface.

groups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> groups

The security groups associated with the network interface.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

sourceDestCheck

Boolean sourceDestCheck

Indicates whether source/destination checking is enabled.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesRequest

class DescribeNetworkInterfacesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

networkInterfaceIds

com.amazonaws.internal.SdkInternalList<String> networkInterfaceIds

One or more network interface IDs.

Default: Describes all your network interfaces.

Class com.amazonaws.services.ec2.model.DescribeNetworkInterfacesResult

class DescribeNetworkInterfacesResult extends Object implements Serializable

Serialized Fields

networkInterfaces

com.amazonaws.internal.SdkInternalList<NetworkInterface> networkInterfaces

Information about one or more network interfaces.

Class com.amazonaws.services.ec2.model.DescribePlacementGroupsRequest

class DescribePlacementGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

groupNames

com.amazonaws.internal.SdkInternalList<String> groupNames

One or more placement group names.

Default: Describes all your placement groups, or only those otherwise specified.

Class com.amazonaws.services.ec2.model.DescribePlacementGroupsResult

class DescribePlacementGroupsResult extends Object implements Serializable

Serialized Fields

placementGroups

com.amazonaws.internal.SdkInternalList<PlacementGroup> placementGroups

One or more placement groups.

Class com.amazonaws.services.ec2.model.DescribePrefixListsRequest

class DescribePrefixListsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.)

prefixListIds

com.amazonaws.internal.SdkInternalList<String> prefixListIds

One or more prefix list IDs.

Class com.amazonaws.services.ec2.model.DescribePrefixListsResult

class DescribePrefixListsResult extends Object implements Serializable

Serialized Fields

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.

prefixLists

com.amazonaws.internal.SdkInternalList<PrefixList> prefixLists

All available prefix lists.

Class com.amazonaws.services.ec2.model.DescribeRegionsRequest

class DescribeRegionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

regionNames

com.amazonaws.internal.SdkInternalList<String> regionNames

The names of one or more regions.

Class com.amazonaws.services.ec2.model.DescribeRegionsResult

class DescribeRegionsResult extends Object implements Serializable

Serialized Fields

regions

com.amazonaws.internal.SdkInternalList<Region> regions

Information about one or more regions.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsRequest

class DescribeReservedInstancesListingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

reservedInstancesId

String reservedInstancesId

One or more Reserved Instance IDs.

reservedInstancesListingId

String reservedInstancesListingId

One or more Reserved Instance listing IDs.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesListingsResult

class DescribeReservedInstancesListingsResult extends Object implements Serializable

Serialized Fields

reservedInstancesListings

com.amazonaws.internal.SdkInternalList<ReservedInstancesListing> reservedInstancesListings

Information about the Reserved Instance listing.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsRequest

class DescribeReservedInstancesModificationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

nextToken

String nextToken

The token to retrieve the next page of results.

reservedInstancesModificationIds

com.amazonaws.internal.SdkInternalList<String> reservedInstancesModificationIds

IDs for the submitted modification request.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesModificationsResult

class DescribeReservedInstancesModificationsResult extends Object implements Serializable

Serialized Fields

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.

reservedInstancesModifications

com.amazonaws.internal.SdkInternalList<ReservedInstancesModification> reservedInstancesModifications

The Reserved Instance modification information.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsRequest

class DescribeReservedInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone in which the Reserved Instance can be used.

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

includeMarketplace

Boolean includeMarketplace

Include Reserved Instance Marketplace offerings in the response.

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

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.

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

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

minDuration

Long minDuration

The minimum duration (in seconds) to filter when searching for offerings.

Default: 2592000 (1 month)

nextToken

String nextToken

The token to retrieve the next page of results.

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.

productDescription

String productDescription

The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.

reservedInstancesOfferingIds

com.amazonaws.internal.SdkInternalList<String> reservedInstancesOfferingIds

One or more Reserved Instances offering IDs.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesOfferingsResult

class DescribeReservedInstancesOfferingsResult extends Object implements Serializable

Serialized Fields

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.

reservedInstancesOfferings

com.amazonaws.internal.SdkInternalList<ReservedInstancesOffering> reservedInstancesOfferings

A list of Reserved Instances offerings.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesRequest

class DescribeReservedInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

reservedInstancesIds

com.amazonaws.internal.SdkInternalList<String> reservedInstancesIds

One or more Reserved Instance IDs.

Default: Describes all your Reserved Instances, or only those otherwise specified.

Class com.amazonaws.services.ec2.model.DescribeReservedInstancesResult

class DescribeReservedInstancesResult extends Object implements Serializable

Serialized Fields

reservedInstances

com.amazonaws.internal.SdkInternalList<ReservedInstances> reservedInstances

A list of Reserved Instances.

Class com.amazonaws.services.ec2.model.DescribeRouteTablesRequest

class DescribeRouteTablesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

routeTableIds

com.amazonaws.internal.SdkInternalList<String> routeTableIds

One or more route table IDs.

Default: Describes all your route tables.

Class com.amazonaws.services.ec2.model.DescribeRouteTablesResult

class DescribeRouteTablesResult extends Object implements Serializable

Serialized Fields

routeTables

com.amazonaws.internal.SdkInternalList<RouteTable> routeTables

Information about one or more route tables.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstanceAvailabilityRequest

class DescribeScheduledInstanceAvailabilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

firstSlotStartTimeRange

SlotDateTimeRangeRequest firstSlotStartTimeRange

The time period for the first schedule to start.

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.

maxSlotDurationInHours

Integer maxSlotDurationInHours

The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.

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.

nextToken

String nextToken

The token for the next set of results.

recurrence

ScheduledInstanceRecurrenceRequest recurrence

The schedule recurrence.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstanceAvailabilityResult

class 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<ScheduledInstanceAvailability> scheduledInstanceAvailabilitySet

Information about the available Scheduled Instances.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesRequest

class DescribeScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

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.

nextToken

String nextToken

The token for the next set of results.

scheduledInstanceIds

com.amazonaws.internal.SdkInternalList<String> scheduledInstanceIds

One or more Scheduled Instance IDs.

slotStartTimeRange

SlotStartTimeRangeRequest slotStartTimeRange

The time period for the first schedule to start.

Class com.amazonaws.services.ec2.model.DescribeScheduledInstancesResult

class 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<ScheduledInstance> scheduledInstanceSet

Information about the Scheduled Instances.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupReferencesRequest

class DescribeSecurityGroupReferencesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupId

com.amazonaws.internal.SdkInternalList<String> groupId

One or more security group IDs in your account.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupReferencesResult

class DescribeSecurityGroupReferencesResult extends Object implements Serializable

Serialized Fields

securityGroupReferenceSet

com.amazonaws.internal.SdkInternalList<SecurityGroupReference> securityGroupReferenceSet

Information about the VPCs with the referencing security groups.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsRequest

class DescribeSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

groupIds

com.amazonaws.internal.SdkInternalList<String> groupIds

One or more security group IDs. Required for security groups in a nondefault VPC.

Default: Describes all your security groups.

groupNames

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.ec2.model.DescribeSecurityGroupsResult

class DescribeSecurityGroupsResult extends Object implements Serializable

Serialized Fields

securityGroups

com.amazonaws.internal.SdkInternalList<SecurityGroup> securityGroups

Information about one or more security groups.

Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeRequest

class DescribeSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The snapshot attribute you would like to view.

snapshotId

String snapshotId

The ID of the EBS snapshot.

Class com.amazonaws.services.ec2.model.DescribeSnapshotAttributeResult

class DescribeSnapshotAttributeResult extends Object implements Serializable

Serialized Fields

createVolumePermissions

com.amazonaws.internal.SdkInternalList<CreateVolumePermission> createVolumePermissions

A list of permissions for creating volumes from the snapshot.

productCodes

com.amazonaws.internal.SdkInternalList<ProductCode> productCodes

A list of product codes.

snapshotId

String snapshotId

The ID of the EBS snapshot.

Class com.amazonaws.services.ec2.model.DescribeSnapshotsRequest

class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

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.

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.

ownerIds

com.amazonaws.internal.SdkInternalList<String> ownerIds

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

restorableByUserIds

com.amazonaws.internal.SdkInternalList<String> restorableByUserIds

One or more AWS accounts IDs that can create volumes from the snapshot.

snapshotIds

com.amazonaws.internal.SdkInternalList<String> snapshotIds

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

Class com.amazonaws.services.ec2.model.DescribeSnapshotsResult

class DescribeSnapshotsResult extends Object implements Serializable

Serialized Fields

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.

snapshots

com.amazonaws.internal.SdkInternalList<Snapshot> snapshots

Information about the snapshots.

Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionRequest

class DescribeSpotDatafeedSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.ec2.model.DescribeSpotDatafeedSubscriptionResult

class DescribeSpotDatafeedSubscriptionResult extends Object implements Serializable

Serialized Fields

spotDatafeedSubscription

SpotDatafeedSubscription spotDatafeedSubscription

The Spot instance data feed subscription.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetInstancesRequest

class DescribeSpotFleetInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

spotFleetRequestId

String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetInstancesResult

class DescribeSpotFleetInstancesResult extends Object implements Serializable

Serialized Fields

activeInstances

com.amazonaws.internal.SdkInternalList<ActiveInstance> 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.

spotFleetRequestId

String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestHistoryRequest

class DescribeSpotFleetRequestHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eventType

String eventType

The type of events to describe. By default, all events are described.

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.

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

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestHistoryResult

class DescribeSpotFleetRequestHistoryResult extends Object implements Serializable

Serialized Fields

historyRecords

com.amazonaws.internal.SdkInternalList<HistoryRecord> historyRecords

Information about the events in the history of the Spot fleet request.

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.

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.

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

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestsRequest

class DescribeSpotFleetRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

spotFleetRequestIds

com.amazonaws.internal.SdkInternalList<String> spotFleetRequestIds

The IDs of the Spot fleet requests.

Class com.amazonaws.services.ec2.model.DescribeSpotFleetRequestsResult

class DescribeSpotFleetRequestsResult 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.

spotFleetRequestConfigs

com.amazonaws.internal.SdkInternalList<SpotFleetRequestConfig> spotFleetRequestConfigs

Information about the configuration of your Spot fleet.

Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsRequest

class DescribeSpotInstanceRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

spotInstanceRequestIds

com.amazonaws.internal.SdkInternalList<String> spotInstanceRequestIds

One or more Spot instance request IDs.

Class com.amazonaws.services.ec2.model.DescribeSpotInstanceRequestsResult

class DescribeSpotInstanceRequestsResult extends Object implements Serializable

Serialized Fields

spotInstanceRequests

com.amazonaws.internal.SdkInternalList<SpotInstanceRequest> spotInstanceRequests

One or more Spot instance requests.

Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryRequest

class DescribeSpotPriceHistoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

Filters the results by the specified Availability Zone.

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

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

instanceTypes

com.amazonaws.internal.SdkInternalList<String> instanceTypes

Filters the results by the specified instance types.

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.

productDescriptions

com.amazonaws.internal.SdkInternalList<String> productDescriptions

Filters the results by the specified basic product descriptions.

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

Class com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryResult

class DescribeSpotPriceHistoryResult 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.

spotPriceHistory

com.amazonaws.internal.SdkInternalList<SpotPrice> spotPriceHistory

The historical Spot prices.

Class com.amazonaws.services.ec2.model.DescribeStaleSecurityGroupsRequest

class DescribeStaleSecurityGroupsRequest 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.

nextToken

String nextToken

The token for the next set of items to return. (You received this token from a prior call.)

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DescribeStaleSecurityGroupsResult

class DescribeStaleSecurityGroupsResult extends Object implements Serializable

Serialized Fields

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.

staleSecurityGroupSet

com.amazonaws.internal.SdkInternalList<StaleSecurityGroup> staleSecurityGroupSet

Information about the stale security groups.

Class com.amazonaws.services.ec2.model.DescribeSubnetsRequest

class DescribeSubnetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

One or more subnet IDs.

Default: Describes all your subnets.

Class com.amazonaws.services.ec2.model.DescribeSubnetsResult

class DescribeSubnetsResult extends Object implements Serializable

Serialized Fields

subnets

com.amazonaws.internal.SdkInternalList<Subnet> subnets

Information about one or more subnets.

Class com.amazonaws.services.ec2.model.DescribeTagsRequest

class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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

class DescribeTagsResult extends Object implements Serializable

Serialized Fields

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

tags

com.amazonaws.internal.SdkInternalList<TagDescription> tags

A list of tags.

Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeRequest

class DescribeVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The instance attribute.

volumeId

String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DescribeVolumeAttributeResult

class DescribeVolumeAttributeResult extends Object implements Serializable

Serialized Fields

autoEnableIO

Boolean autoEnableIO

The state of autoEnableIO attribute.

productCodes

com.amazonaws.internal.SdkInternalList<ProductCode> productCodes

A list of product codes.

volumeId

String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DescribeVolumesRequest

class DescribeVolumesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

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.

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.

volumeIds

com.amazonaws.internal.SdkInternalList<String> volumeIds

One or more volume IDs.

Class com.amazonaws.services.ec2.model.DescribeVolumesResult

class DescribeVolumesResult extends Object implements Serializable

Serialized Fields

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.

volumes

com.amazonaws.internal.SdkInternalList<Volume> volumes

Information about the volumes.

Class com.amazonaws.services.ec2.model.DescribeVolumeStatusRequest

class DescribeVolumeStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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).

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.

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.

volumeIds

com.amazonaws.internal.SdkInternalList<String> volumeIds

One or more volume IDs.

Default: Describes all your volumes.

Class com.amazonaws.services.ec2.model.DescribeVolumeStatusResult

class DescribeVolumeStatusResult extends Object implements Serializable

Serialized Fields

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.

volumeStatuses

com.amazonaws.internal.SdkInternalList<VolumeStatusItem> volumeStatuses

A list of volumes.

Class com.amazonaws.services.ec2.model.DescribeVpcAttributeRequest

class DescribeVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The VPC attribute.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DescribeVpcAttributeResult

class DescribeVpcAttributeResult extends Object implements Serializable

Serialized Fields

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.

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.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportRequest

class DescribeVpcClassicLinkDnsSupportRequest 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.

nextToken

String nextToken

The token for the next set of items to return. (You received this token from a prior call.)

vpcIds

com.amazonaws.internal.SdkInternalList<String> vpcIds

One or more VPC IDs.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkDnsSupportResult

class DescribeVpcClassicLinkDnsSupportResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The token to use when requesting the next set of items.

vpcs

com.amazonaws.internal.SdkInternalList<ClassicLinkDnsSupport> vpcs

Information about the ClassicLink DNS support status of the VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkRequest

class DescribeVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

vpcIds

com.amazonaws.internal.SdkInternalList<String> vpcIds

One or more VPCs for which you want to describe the ClassicLink status.

Class com.amazonaws.services.ec2.model.DescribeVpcClassicLinkResult

class DescribeVpcClassicLinkResult extends Object implements Serializable

Serialized Fields

vpcs

com.amazonaws.internal.SdkInternalList<VpcClassicLink> vpcs

The ClassicLink status of one or more VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpcEndpointServicesRequest

class 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

class DescribeVpcEndpointServicesResult extends Object implements Serializable

Serialized Fields

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.

serviceNames

com.amazonaws.internal.SdkInternalList<String> serviceNames

A list of supported AWS services.

Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsRequest

class DescribeVpcEndpointsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.)

vpcEndpointIds

com.amazonaws.internal.SdkInternalList<String> vpcEndpointIds

One or more endpoint IDs.

Class com.amazonaws.services.ec2.model.DescribeVpcEndpointsResult

class DescribeVpcEndpointsResult extends Object implements Serializable

Serialized Fields

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.

vpcEndpoints

com.amazonaws.internal.SdkInternalList<VpcEndpoint> vpcEndpoints

Information about the endpoints.

Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsRequest

class DescribeVpcPeeringConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

vpcPeeringConnectionIds

com.amazonaws.internal.SdkInternalList<String> vpcPeeringConnectionIds

One or more VPC peering connection IDs.

Default: Describes all your VPC peering connections.

Class com.amazonaws.services.ec2.model.DescribeVpcPeeringConnectionsResult

class DescribeVpcPeeringConnectionsResult extends Object implements Serializable

Serialized Fields

vpcPeeringConnections

com.amazonaws.internal.SdkInternalList<VpcPeeringConnection> vpcPeeringConnections

Information about the VPC peering connections.

Class com.amazonaws.services.ec2.model.DescribeVpcsRequest

class DescribeVpcsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

vpcIds

com.amazonaws.internal.SdkInternalList<String> vpcIds

One or more VPC IDs.

Default: Describes all your VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpcsResult

class DescribeVpcsResult extends Object implements Serializable

Serialized Fields

vpcs

com.amazonaws.internal.SdkInternalList<Vpc> vpcs

Information about one or more VPCs.

Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsRequest

class DescribeVpnConnectionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

vpnConnectionIds

com.amazonaws.internal.SdkInternalList<String> vpnConnectionIds

One or more VPN connection IDs.

Default: Describes your VPN connections.

Class com.amazonaws.services.ec2.model.DescribeVpnConnectionsResult

class DescribeVpnConnectionsResult extends Object implements Serializable

Serialized Fields

vpnConnections

com.amazonaws.internal.SdkInternalList<VpnConnection> vpnConnections

Information about one or more VPN connections.

Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysRequest

class DescribeVpnGatewaysRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

vpnGatewayIds

com.amazonaws.internal.SdkInternalList<String> vpnGatewayIds

One or more virtual private gateway IDs.

Default: Describes all your virtual private gateways.

Class com.amazonaws.services.ec2.model.DescribeVpnGatewaysResult

class DescribeVpnGatewaysResult extends Object implements Serializable

Serialized Fields

vpnGateways

com.amazonaws.internal.SdkInternalList<VpnGateway> vpnGateways

Information about one or more virtual private gateways.

Class com.amazonaws.services.ec2.model.DetachClassicLinkVpcRequest

class 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

class 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

class 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.DetachInternetGatewayResult

class DetachInternetGatewayResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DetachNetworkInterfaceRequest

class 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.DetachNetworkInterfaceResult

class DetachNetworkInterfaceResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DetachVolumeRequest

class DetachVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

instanceId

String instanceId

The ID of the instance.

volumeId

String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.DetachVolumeResult

class DetachVolumeResult extends Object implements Serializable

Serialized Fields

attachment

VolumeAttachment attachment

Describes volume attachment details.

Class com.amazonaws.services.ec2.model.DetachVpnGatewayRequest

class DetachVpnGatewayRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

vpnGatewayId

String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.DetachVpnGatewayResult

class DetachVpnGatewayResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DhcpConfiguration

class DhcpConfiguration extends Object implements Serializable

Serialized Fields

key

String key

The name of a DHCP option.

values

com.amazonaws.internal.SdkInternalList<String> values

One or more values for the DHCP option.

Class com.amazonaws.services.ec2.model.DhcpOptions

class DhcpOptions extends Object implements Serializable

Serialized Fields

dhcpConfigurations

com.amazonaws.internal.SdkInternalList<DhcpConfiguration> dhcpConfigurations

One or more DHCP options in the set.

dhcpOptionsId

String dhcpOptionsId

The ID of the set of DHCP options.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the DHCP options set.

Class com.amazonaws.services.ec2.model.DisableVgwRoutePropagationRequest

class DisableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayId

String gatewayId

The ID of the virtual private gateway.

routeTableId

String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.DisableVgwRoutePropagationResult

class DisableVgwRoutePropagationResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportRequest

class DisableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkDnsSupportResult

class 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

class DisableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.DisableVpcClassicLinkResult

class 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

class DisassociateAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

associationId

String associationId

[EC2-VPC] The association ID. Required for EC2-VPC.

publicIp

String publicIp

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

Class com.amazonaws.services.ec2.model.DisassociateAddressResult

class DisassociateAddressResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DisassociateRouteTableRequest

class 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.DisassociateRouteTableResult

class DisassociateRouteTableResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.DiskImage

class DiskImage extends Object implements Serializable

Serialized Fields

description

String description

A description of the disk image.

image

DiskImageDetail image

Information about the disk image.

volume

VolumeDetail volume

Information about the volume.

Class com.amazonaws.services.ec2.model.DiskImageDescription

class DiskImageDescription extends Object implements Serializable

Serialized Fields

checksum

String checksum

The checksum computed for the disk image.

format

String format

The disk image format.

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.

size

Long size

The size of the disk image, in GiB.

Class com.amazonaws.services.ec2.model.DiskImageDetail

class DiskImageDetail extends Object implements Serializable

Serialized Fields

bytes

Long bytes

The size of the disk image, in GiB.

format

String format

The disk image format.

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

class DiskImageVolumeDescription extends Object implements Serializable

Serialized Fields

id

String id

The volume identifier.

size

Long size

The size of the volume, in GiB.

Class com.amazonaws.services.ec2.model.EbsBlockDevice

class EbsBlockDevice extends Object implements Serializable

Serialized Fields

deleteOnTermination

Boolean deleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.

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.

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.

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.

volumeType

String volumeType

The volume type: gp2, io1, st1, sc1, or standard.

Default: standard

Class com.amazonaws.services.ec2.model.EbsInstanceBlockDevice

class EbsInstanceBlockDevice extends Object implements Serializable

Serialized Fields

attachTime

Date attachTime

The time stamp when the attachment initiated.

deleteOnTermination

Boolean deleteOnTermination

Indicates whether the volume is deleted on instance termination.

status

String status

The attachment state.

volumeId

String volumeId

The ID of the EBS volume.

Class com.amazonaws.services.ec2.model.EbsInstanceBlockDeviceSpecification

class EbsInstanceBlockDeviceSpecification extends Object implements Serializable

Serialized Fields

deleteOnTermination

Boolean deleteOnTermination

Indicates whether the volume is deleted on instance termination.

volumeId

String volumeId

The ID of the EBS volume.

Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationRequest

class EnableVgwRoutePropagationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gatewayId

String gatewayId

The ID of the virtual private gateway.

routeTableId

String routeTableId

The ID of the route table.

Class com.amazonaws.services.ec2.model.EnableVgwRoutePropagationResult

class EnableVgwRoutePropagationResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.EnableVolumeIORequest

class EnableVolumeIORequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.EnableVolumeIOResult

class EnableVolumeIOResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportRequest

class EnableVpcClassicLinkDnsSupportRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkDnsSupportResult

class 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

class EnableVpcClassicLinkRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.EnableVpcClassicLinkResult

class 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

class EventInformation extends Object implements Serializable

Serialized Fields

eventDescription

String eventDescription

The description of the event.

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.

instanceId

String instanceId

The ID of the instance. This information is available only for instanceChange events.

Class com.amazonaws.services.ec2.model.ExportTask

class ExportTask extends Object implements Serializable

Serialized Fields

description

String description

A description of the resource being exported.

exportTaskId

String exportTaskId

The ID of the export task.

exportToS3Task

ExportToS3Task exportToS3Task

Information about the export task.

instanceExportDetails

InstanceExportDetails instanceExportDetails

Information about the instance to export.

state

String state

The state of the export task.

statusMessage

String statusMessage

The status message related to the export task.

Class com.amazonaws.services.ec2.model.ExportToS3Task

class ExportToS3Task extends Object implements Serializable

Serialized Fields

containerFormat

String containerFormat

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

diskImageFormat

String diskImageFormat

The format for the exported image.

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 vm-import-export@amazon.com.

s3Key

String s3Key

The encryption key for your S3 bucket.

Class com.amazonaws.services.ec2.model.ExportToS3TaskSpecification

class ExportToS3TaskSpecification extends Object implements Serializable

Serialized Fields

containerFormat

String containerFormat

The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.

diskImageFormat

String diskImageFormat

The format for the exported image.

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 vm-import-export@amazon.com.

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

class 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<String> values

One or more filter values. Filter values are case-sensitive.

Class com.amazonaws.services.ec2.model.FlowLog

class FlowLog extends Object implements Serializable

Serialized Fields

creationTime

Date creationTime

The date and time the flow log was created.

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.

deliverLogsStatus

String deliverLogsStatus

The status of the logs delivery (SUCCESS | FAILED).

flowLogId

String flowLogId

The flow log ID.

flowLogStatus

String flowLogStatus

The status of the flow log (ACTIVE).

logGroupName

String logGroupName

The name of the flow log group.

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.

Class com.amazonaws.services.ec2.model.GetConsoleOutputRequest

class GetConsoleOutputRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance.

Class com.amazonaws.services.ec2.model.GetConsoleOutputResult

class GetConsoleOutputResult extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance.

output

String output

The console output, Base64 encoded. If using a command line tool, the tools decode the output for you.

timestamp

Date timestamp

The time the output was last updated.

Class com.amazonaws.services.ec2.model.GetPasswordDataRequest

class GetPasswordDataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the Windows instance.

Class com.amazonaws.services.ec2.model.GetPasswordDataResult

class GetPasswordDataResult extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the Windows instance.

passwordData

String passwordData

The password of the instance.

timestamp

Date timestamp

The time the data was last updated.

Class com.amazonaws.services.ec2.model.GroupIdentifier

class GroupIdentifier extends Object implements Serializable

Serialized Fields

groupId

String groupId

The ID of the security group.

groupName

String groupName

The name of the security group.

Class com.amazonaws.services.ec2.model.HistoryRecord

class HistoryRecord extends Object implements Serializable

Serialized Fields

eventInformation

EventInformation eventInformation

Information about the event.

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.

timestamp

Date timestamp

The date and time of the event, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.Host

class Host extends Object implements Serializable

Serialized Fields

autoPlacement

String autoPlacement

Whether auto-placement is on or off.

availabilityZone

String availabilityZone

The Availability Zone of the Dedicated host.

availableCapacity

AvailableCapacity availableCapacity

The number of new instances that can be launched onto the Dedicated host.

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.

hostId

String hostId

The ID of the Dedicated host.

hostProperties

HostProperties hostProperties

The hardware specifications of the Dedicated host.

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.

instances

com.amazonaws.internal.SdkInternalList<HostInstance> instances

The IDs and instance type that are currently running on the Dedicated host.

state

String state

The Dedicated host's state.

Class com.amazonaws.services.ec2.model.HostInstance

class 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

class HostProperties extends Object implements Serializable

Serialized Fields

cores

Integer cores

The number of cores on the Dedicated host.

instanceType

String instanceType

The instance type size that the Dedicated host supports (for example, m3.medium).

sockets

Integer sockets

The number of sockets on the Dedicated host.

totalVCpus

Integer totalVCpus

The number of vCPUs on the Dedicated host.

Class com.amazonaws.services.ec2.model.IamInstanceProfile

class 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

class 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

class IcmpTypeCode extends Object implements Serializable

Serialized Fields

code

Integer code

The ICMP type. A value of -1 means all types.

type

Integer type

The ICMP code. A value of -1 means all codes for the specified ICMP type.

Class com.amazonaws.services.ec2.model.IdFormat

class IdFormat extends Object implements Serializable

Serialized Fields

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.

resource

String resource

The type of resource.

useLongIds

Boolean useLongIds

Indicates whether longer IDs (17-character IDs) are enabled for the resource.

Class com.amazonaws.services.ec2.model.Image

class Image extends Object implements Serializable

Serialized Fields

architecture

String architecture

The architecture of the image.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> blockDeviceMappings

Any block device mapping entries.

creationDate

String creationDate

The date and time the image was created.

description

String description

The description of the AMI that was provided during image creation.

hypervisor

String hypervisor

The hypervisor type of the image.

imageId

String imageId

The ID of the AMI.

imageLocation

String imageLocation

The location of the AMI.

imageOwnerAlias

String imageOwnerAlias

The AWS account alias (for example, amazon, self) or the AWS account ID of the AMI owner.

imageType

String imageType

The type of image.

kernelId

String kernelId

The kernel associated with the image, if any. Only applicable for machine images.

name

String name

The name of the AMI that was provided during image creation.

ownerId

String ownerId

The AWS account ID of the image owner.

platform

String platform

The value is Windows for Windows AMIs; otherwise blank.

productCodes

com.amazonaws.internal.SdkInternalList<ProductCode> productCodes

Any product codes associated with the AMI.

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.

ramdiskId

String ramdiskId

The RAM disk associated with the image, if any. Only applicable for machine images.

rootDeviceName

String rootDeviceName

The device name of the root device (for example, /dev/sda1 or /dev/xvda).

rootDeviceType

String rootDeviceType

The type of root device used by the AMI. The AMI can use an EBS volume or an instance store volume.

sriovNetSupport

String sriovNetSupport

Specifies whether enhanced networking is enabled.

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.

stateReason

StateReason stateReason

The reason for the state change.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the image.

virtualizationType

String virtualizationType

The type of virtualization of the AMI.

Class com.amazonaws.services.ec2.model.ImageAttribute

class ImageAttribute extends Object implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

description

String description

A description for the AMI.

imageId

String imageId

The ID of the AMI.

kernelId

String kernelId

The kernel ID.

launchPermissions

com.amazonaws.internal.SdkInternalList<LaunchPermission> launchPermissions

One or more launch permissions.

productCodes

com.amazonaws.internal.SdkInternalList<ProductCode> productCodes

One or more product codes.

ramdiskId

String ramdiskId

The RAM disk ID.

sriovNetSupport

String sriovNetSupport

Class com.amazonaws.services.ec2.model.ImageDiskContainer

class ImageDiskContainer extends Object implements Serializable

Serialized Fields

description

String description

The description of the disk image.

deviceName

String deviceName

The block device mapping for the disk.

format

String format

The format of the disk image being imported.

Valid values: RAW | VHD | VMDK | OVA

snapshotId

String snapshotId

The ID of the EBS snapshot to be used for importing the snapshot.

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.

Class com.amazonaws.services.ec2.model.ImportImageRequest

class ImportImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

architecture

String architecture

The architecture of the virtual machine.

Valid values: i386 | x86_64

clientData

ClientData clientData

The client-specific data.

clientToken

String clientToken

The token to enable idempotency for VM import requests.

description

String description

A description string for the import image task.

diskContainers

com.amazonaws.internal.SdkInternalList<ImageDiskContainer> diskContainers

Information about the disk containers.

hypervisor

String hypervisor

The target hypervisor platform.

Valid values: xen

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

platform

String platform

The operating system of the virtual machine.

Valid values: Windows | Linux

roleName

String roleName

The name of the role to use when not using the default role, 'vmimport'.

Class com.amazonaws.services.ec2.model.ImportImageResult

class ImportImageResult extends Object implements Serializable

Serialized Fields

architecture

String architecture

The architecture of the virtual machine.

description

String description

A description of the import task.

hypervisor

String hypervisor

The target hypervisor of the import task.

imageId

String imageId

The ID of the Amazon Machine Image (AMI) created by the import task.

importTaskId

String importTaskId

The task ID of the import image task.

licenseType

String licenseType

The license type of the virtual machine.

platform

String platform

The operating system of the virtual machine.

progress

String progress

The progress of the task.

snapshotDetails

com.amazonaws.internal.SdkInternalList<SnapshotDetail> snapshotDetails

Information about the snapshots.

status

String status

A brief status of the task.

statusMessage

String statusMessage

A detailed status message of the import task.

Class com.amazonaws.services.ec2.model.ImportImageTask

class ImportImageTask extends Object implements Serializable

Serialized Fields

architecture

String architecture

The architecture of the virtual machine.

Valid values: i386 | x86_64

description

String description

A description of the import task.

hypervisor

String hypervisor

The target hypervisor for the import task.

Valid values: xen

imageId

String imageId

The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

importTaskId

String importTaskId

The ID of the import image task.

licenseType

String licenseType

The license type of the virtual machine.

platform

String platform

The description string for the import image task.

progress

String progress

The percentage of progress of the import image task.

snapshotDetails

com.amazonaws.internal.SdkInternalList<SnapshotDetail> snapshotDetails

Information about the snapshots.

status

String status

A brief status for the import image task.

statusMessage

String statusMessage

A descriptive status message for the import image task.

Class com.amazonaws.services.ec2.model.ImportInstanceLaunchSpecification

class ImportInstanceLaunchSpecification extends Object implements Serializable

Serialized Fields

additionalInfo

String additionalInfo

Reserved.

architecture

String architecture

The architecture of the instance.

groupIds

com.amazonaws.internal.SdkInternalList<String> groupIds

One or more security group IDs.

groupNames

com.amazonaws.internal.SdkInternalList<String> groupNames

One or more security group names.

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

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.

monitoring

Boolean monitoring

Indicates whether monitoring is enabled.

placement

Placement placement

The placement information for the instance.

privateIpAddress

String privateIpAddress

[EC2-VPC] An available IP address from the IP address range of the subnet.

subnetId

String subnetId

[EC2-VPC] The ID of the subnet in which to launch the instance.

userData

UserData userData

The Base64-encoded MIME user data to be made available to the instance.

Class com.amazonaws.services.ec2.model.ImportInstanceRequest

class ImportInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

A description for the instance being imported.

diskImages

com.amazonaws.internal.SdkInternalList<DiskImage> diskImages

The disk image.

launchSpecification

ImportInstanceLaunchSpecification launchSpecification

The launch specification.

platform

String platform

The instance operating system.

Class com.amazonaws.services.ec2.model.ImportInstanceResult

class ImportInstanceResult extends Object implements Serializable

Serialized Fields

conversionTask

ConversionTask conversionTask

Information about the conversion task.

Class com.amazonaws.services.ec2.model.ImportInstanceTaskDetails

class ImportInstanceTaskDetails extends Object implements Serializable

Serialized Fields

description

String description

A description of the task.

instanceId

String instanceId

The ID of the instance.

platform

String platform

The instance operating system.

volumes

com.amazonaws.internal.SdkInternalList<ImportInstanceVolumeDetailItem> volumes

One or more volumes.

Class com.amazonaws.services.ec2.model.ImportInstanceVolumeDetailItem

class ImportInstanceVolumeDetailItem extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone where the resulting instance will reside.

bytesConverted

Long bytesConverted

The number of bytes converted so far.

description

String description

A description of the task.

image

DiskImageDescription image

The image.

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.

volume

DiskImageVolumeDescription volume

The volume.

Class com.amazonaws.services.ec2.model.ImportKeyPairRequest

class 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

class ImportKeyPairResult extends Object implements Serializable

Serialized Fields

keyFingerprint

String keyFingerprint

The MD5 public key fingerprint as specified in section 4 of RFC 4716.

keyName

String keyName

The key pair name you provided.

Class com.amazonaws.services.ec2.model.ImportSnapshotRequest

class ImportSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientData

ClientData clientData

The client-specific data.

clientToken

String clientToken

Token to enable idempotency for VM import requests.

description

String description

The description string for the import snapshot task.

diskContainer

SnapshotDiskContainer diskContainer

Information about the disk container.

roleName

String roleName

The name of the role to use when not using the default role, 'vmimport'.

Class com.amazonaws.services.ec2.model.ImportSnapshotResult

class ImportSnapshotResult extends Object implements Serializable

Serialized Fields

description

String description

A description of the import snapshot task.

importTaskId

String importTaskId

The ID of the import snapshot task.

snapshotTaskDetail

SnapshotTaskDetail snapshotTaskDetail

Information about the import snapshot task.

Class com.amazonaws.services.ec2.model.ImportSnapshotTask

class ImportSnapshotTask extends Object implements Serializable

Serialized Fields

description

String description

A description of the import snapshot task.

importTaskId

String importTaskId

The ID of the import snapshot task.

snapshotTaskDetail

SnapshotTaskDetail snapshotTaskDetail

Describes an import snapshot task.

Class com.amazonaws.services.ec2.model.ImportVolumeRequest

class ImportVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone for the resulting EBS volume.

description

String description

A description of the volume.

image

DiskImageDetail image

The disk image.

volume

VolumeDetail volume

The volume size.

Class com.amazonaws.services.ec2.model.ImportVolumeResult

class ImportVolumeResult extends Object implements Serializable

Serialized Fields

conversionTask

ConversionTask conversionTask

Information about the conversion task.

Class com.amazonaws.services.ec2.model.ImportVolumeTaskDetails

class ImportVolumeTaskDetails extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone where the resulting volume will reside.

bytesConverted

Long bytesConverted

The number of bytes converted so far.

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

class Instance extends Object implements Serializable

Serialized Fields

amiLaunchIndex

Integer amiLaunchIndex

The AMI launch index, which can be used to find this instance in the launch group.

architecture

String architecture

The architecture of the image.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<InstanceBlockDeviceMapping> blockDeviceMappings

Any block device mapping entries for the instance.

clientToken

String clientToken

The idempotency token you provided when you launched 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.

hypervisor

String hypervisor

The hypervisor type of the instance.

iamInstanceProfile

IamInstanceProfile iamInstanceProfile

The IAM instance profile associated with the instance, if applicable.

imageId

String imageId

The ID of the AMI used to launch the instance.

instanceId

String instanceId

The ID of the instance.

instanceLifecycle

String instanceLifecycle

Indicates whether this is a Spot instance or a Scheduled Instance.

instanceType

String instanceType

The instance type.

kernelId

String kernelId

The kernel associated with this instance, if applicable.

keyName

String keyName

The name of the key pair, if this instance was launched with an associated key pair.

launchTime

Date launchTime

The time the instance was launched.

monitoring

Monitoring monitoring

The monitoring information for the instance.

networkInterfaces

com.amazonaws.internal.SdkInternalList<InstanceNetworkInterface> networkInterfaces

[EC2-VPC] One or more network interfaces for the instance.

placement

Placement placement

The location where the instance launched, if applicable.

platform

String platform

The value is Windows for Windows instances; otherwise blank.

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.

privateIpAddress

String privateIpAddress

The private IP address assigned to the instance.

productCodes

com.amazonaws.internal.SdkInternalList<ProductCode> productCodes

The product codes attached to this instance, if applicable.

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.

publicIpAddress

String publicIpAddress

The public IP address assigned to the instance, if applicable.

ramdiskId

String ramdiskId

The RAM disk associated with this instance, if applicable.

rootDeviceName

String rootDeviceName

The root device name (for example, /dev/sda1 or /dev/xvda).

rootDeviceType

String rootDeviceType

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

securityGroups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> 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.

spotInstanceRequestId

String spotInstanceRequestId

If the request is a Spot instance request, the ID of the request.

sriovNetSupport

String sriovNetSupport

Specifies whether enhanced networking is enabled.

state

InstanceState state

The current state of the instance.

stateReason

StateReason stateReason

The reason for the most recent state transition.

stateTransitionReason

String stateTransitionReason

The reason for the most recent state transition. This might be an empty string.

subnetId

String subnetId

[EC2-VPC] The ID of the subnet in which the instance is running.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the instance.

virtualizationType

String virtualizationType

The virtualization type of the instance.

vpcId

String vpcId

[EC2-VPC] The ID of the VPC in which the instance is running.

Class com.amazonaws.services.ec2.model.InstanceAttribute

class InstanceAttribute extends Object implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<InstanceBlockDeviceMapping> blockDeviceMappings

The block device mapping of the instance.

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.

ebsOptimized

Boolean ebsOptimized

Indicates whether the instance is optimized for EBS I/O.

groups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> groups

The security groups associated with the instance.

instanceId

String instanceId

The ID of 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).

instanceType

String instanceType

The instance type.

kernelId

String kernelId

The kernel ID.

productCodes

com.amazonaws.internal.SdkInternalList<ProductCode> productCodes

A list of product codes.

ramdiskId

String ramdiskId

The RAM disk ID.

rootDeviceName

String rootDeviceName

The name of the root device (for example, /dev/sda1 or /dev/xvda).

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.

sriovNetSupport

String sriovNetSupport

userData

String userData

The Base64-encoded MIME user data.

Class com.amazonaws.services.ec2.model.InstanceBlockDeviceMapping

class 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

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

noDevice

String noDevice

suppress the specified device included in the block device mapping.

virtualName

String virtualName

The virtual device name.

Class com.amazonaws.services.ec2.model.InstanceCapacity

class InstanceCapacity extends Object implements Serializable

Serialized Fields

availableCapacity

Integer availableCapacity

The number of instances that can still be launched onto the Dedicated host.

instanceType

String instanceType

The instance type size supported by 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

class InstanceCount extends Object implements Serializable

Serialized Fields

instanceCount

Integer instanceCount

The number of listed Reserved Instances in the state specified by the state.

state

String state

The states of the listed Reserved Instances.

Class com.amazonaws.services.ec2.model.InstanceExportDetails

class 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

class 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

class InstanceNetworkInterface extends Object implements Serializable

Serialized Fields

association

InstanceNetworkInterfaceAssociation association

The association information for an Elastic IP associated with the network interface.

attachment

InstanceNetworkInterfaceAttachment attachment

The network interface attachment.

description

String description

The description.

groups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> groups

One or more security groups.

macAddress

String macAddress

The MAC address.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

ownerId

String ownerId

The ID of the AWS account that created the network interface.

privateDnsName

String privateDnsName

The private DNS name.

privateIpAddress

String privateIpAddress

The IP address of the network interface within the subnet.

privateIpAddresses

com.amazonaws.internal.SdkInternalList<InstancePrivateIpAddress> privateIpAddresses

The private IP addresses associated with the network interface.

sourceDestCheck

Boolean sourceDestCheck

Indicates whether to validate network traffic to or from this network interface.

status

String status

The status of the network interface.

subnetId

String subnetId

The ID of the subnet.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAssociation

class InstanceNetworkInterfaceAssociation extends Object implements Serializable

Serialized Fields

ipOwnerId

String ipOwnerId

The ID of the owner of the Elastic IP address.

publicDnsName

String publicDnsName

The public DNS name.

publicIp

String publicIp

The public IP address or Elastic IP address bound to the network interface.

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceAttachment

class InstanceNetworkInterfaceAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

The ID of the network interface attachment.

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.

deviceIndex

Integer deviceIndex

The index of the device on the instance for the network interface attachment.

status

String status

The attachment state.

Class com.amazonaws.services.ec2.model.InstanceNetworkInterfaceSpecification

class InstanceNetworkInterfaceSpecification extends Object implements Serializable

Serialized Fields

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.

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.

description

String description

The description of the network interface. Applies only if creating a network interface when launching an instance.

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.

groups

com.amazonaws.internal.SdkInternalList<String> groups

The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

privateIpAddress

String privateIpAddress

The private IP address of the network interface. Applies only if creating a network interface when launching an instance.

privateIpAddresses

com.amazonaws.internal.SdkInternalList<PrivateIpAddressSpecification> 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.

subnetId

String subnetId

The ID of the subnet associated with the network string. Applies only if creating a network interface when launching an instance.

Class com.amazonaws.services.ec2.model.InstancePrivateIpAddress

class InstancePrivateIpAddress extends Object implements Serializable

Serialized Fields

association

InstanceNetworkInterfaceAssociation association

The association information for an Elastic IP address for the network interface.

primary

Boolean primary

Indicates whether this IP address is the primary private IP address of the network interface.

privateDnsName

String privateDnsName

The private DNS name.

privateIpAddress

String privateIpAddress

The private IP address of the network interface.

Class com.amazonaws.services.ec2.model.InstanceState

class 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

class InstanceStateChange extends Object implements Serializable

Serialized Fields

currentState

InstanceState currentState

The current state of the instance.

instanceId

String instanceId

The ID of the instance.

previousState

InstanceState previousState

The previous state of the instance.

Class com.amazonaws.services.ec2.model.InstanceStatus

class InstanceStatus extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone of the instance.

events

com.amazonaws.internal.SdkInternalList<InstanceStatusEvent> events

Any scheduled events associated with the instance.

instanceId

String instanceId

The ID of the instance.

instanceState

InstanceState instanceState

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

instanceStatus

InstanceStatusSummary instanceStatus

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

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.

Class com.amazonaws.services.ec2.model.InstanceStatusDetails

class InstanceStatusDetails extends Object implements Serializable

Serialized Fields

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.

name

String name

The type of instance status.

status

String status

The status.

Class com.amazonaws.services.ec2.model.InstanceStatusEvent

class 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].

notAfter

Date notAfter

The latest scheduled end time for the event.

notBefore

Date notBefore

The earliest scheduled start time for the event.

Class com.amazonaws.services.ec2.model.InstanceStatusSummary

class InstanceStatusSummary extends Object implements Serializable

Serialized Fields

details

com.amazonaws.internal.SdkInternalList<InstanceStatusDetails> details

The system instance health or application instance health.

status

String status

The status.

Class com.amazonaws.services.ec2.model.InternetGateway

class InternetGateway extends Object implements Serializable

Serialized Fields

attachments

com.amazonaws.internal.SdkInternalList<InternetGatewayAttachment> attachments

Any VPCs attached to the Internet gateway.

internetGatewayId

String internetGatewayId

The ID of the Internet gateway.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the Internet gateway.

Class com.amazonaws.services.ec2.model.InternetGatewayAttachment

class InternetGatewayAttachment extends Object implements Serializable

Serialized Fields

state

String state

The current state of the attachment.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.IpPermission

class IpPermission extends Object implements Serializable

Serialized Fields

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.

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.

ipRanges

com.amazonaws.internal.SdkInternalList<String> ipRanges

One or more IP ranges.

prefixListIds

com.amazonaws.internal.SdkInternalList<PrefixListId> 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.

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<UserIdGroupPair> userIdGroupPairs

One or more security group and AWS account ID pairs.

Class com.amazonaws.services.ec2.model.KeyPair

class KeyPair extends Object implements Serializable

Serialized Fields

keyFingerprint

String keyFingerprint

The SHA-1 digest of the DER encoded private key.

keyMaterial

String keyMaterial

An unencrypted PEM encoded RSA private key.

keyName

String keyName

The name of the key pair.

Class com.amazonaws.services.ec2.model.KeyPairInfo

class KeyPairInfo extends Object implements Serializable

Serialized Fields

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.

keyName

String keyName

The name of the key pair.

Class com.amazonaws.services.ec2.model.LaunchPermission

class LaunchPermission extends Object implements Serializable

Serialized Fields

group

String group

The name of the group.

userId

String userId

The AWS account ID.

Class com.amazonaws.services.ec2.model.LaunchPermissionModifications

class LaunchPermissionModifications extends Object implements Serializable

Serialized Fields

add

com.amazonaws.internal.SdkInternalList<LaunchPermission> add

The AWS account ID to add to the list of launch permissions for the AMI.

remove

com.amazonaws.internal.SdkInternalList<LaunchPermission> remove

The AWS account ID to remove from the list of launch permissions for the AMI.

Class com.amazonaws.services.ec2.model.LaunchSpecification

class LaunchSpecification extends Object implements Serializable

Serialized Fields

addressingType

String addressingType

Deprecated.

allSecurityGroups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> 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.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> 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.

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

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

The IAM instance profile.

imageId

String imageId

The ID of the AMI.

instanceType

String instanceType

The instance type.

kernelId

String kernelId

The ID of the kernel.

keyName

String keyName

The name of the key pair.

monitoringEnabled

Boolean monitoringEnabled

networkInterfaces

com.amazonaws.internal.SdkInternalList<InstanceNetworkInterfaceSpecification> networkInterfaces

One or more network interfaces.

placement

SpotPlacement placement

The placement information for the instance.

ramdiskId

String ramdiskId

The ID of the RAM disk.

securityGroups

com.amazonaws.internal.SdkInternalList<String> securityGroups

One or more security group names.

subnetId

String subnetId

The ID of the subnet in which to launch the instance.

userData

String userData

The Base64-encoded MIME user data to make available to the instances.

Class com.amazonaws.services.ec2.model.ModifyHostsRequest

class ModifyHostsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoPlacement

String autoPlacement

Specify whether to enable or disable auto-placement.

hostIds

com.amazonaws.internal.SdkInternalList<String> hostIds

The host IDs of the Dedicated hosts you want to modify.

Class com.amazonaws.services.ec2.model.ModifyHostsResult

class ModifyHostsResult extends Object implements Serializable

Serialized Fields

successful

com.amazonaws.internal.SdkInternalList<String> successful

The IDs of the Dedicated hosts that were successfully modified.

unsuccessful

com.amazonaws.internal.SdkInternalList<UnsuccessfulItem> 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

class 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.ModifyIdFormatResult

class ModifyIdFormatResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifyImageAttributeRequest

class ModifyImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The name of the attribute to modify.

description

String description

A description for the AMI.

imageId

String imageId

The ID of the AMI.

launchPermission

LaunchPermissionModifications launchPermission

A launch permission modification.

operationType

String operationType

The operation type.

productCodes

com.amazonaws.internal.SdkInternalList<String> 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.

userGroups

com.amazonaws.internal.SdkInternalList<String> userGroups

One or more user groups. This is only valid when modifying the launchPermission attribute.

userIds

com.amazonaws.internal.SdkInternalList<String> userIds

One or more AWS account IDs. This is only valid when modifying the launchPermission attribute.

value

String value

The value of the attribute being modified. This is only valid when modifying the description attribute.

Class com.amazonaws.services.ec2.model.ModifyImageAttributeResult

class ModifyImageAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifyInstanceAttributeRequest

class ModifyInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The name of the attribute.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<InstanceBlockDeviceMappingSpecification> 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.

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.

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.

groups

com.amazonaws.internal.SdkInternalList<String> 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.

instanceId

String instanceId

The ID of the instance.

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

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.

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.

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.

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.

value

String value

A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.

Class com.amazonaws.services.ec2.model.ModifyInstanceAttributeResult

class ModifyInstanceAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifyInstancePlacementRequest

class ModifyInstancePlacementRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

instanceId

String instanceId

The ID of the instance that you are modifying.

tenancy

String tenancy

The tenancy of the instance that you are modifying.

Class com.amazonaws.services.ec2.model.ModifyInstancePlacementResult

class 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

class ModifyNetworkInterfaceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attachment

NetworkInterfaceAttachmentChanges attachment

Information about the interface attachment. If modifying the 'delete on termination' attribute, you must specify the ID of the interface attachment.

description

String description

A description for the network interface.

groups

com.amazonaws.internal.SdkInternalList<String> 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.

networkInterfaceId

String networkInterfaceId

The ID of 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.

Class com.amazonaws.services.ec2.model.ModifyNetworkInterfaceAttributeResult

class ModifyNetworkInterfaceAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifyReservedInstancesRequest

class 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<String> reservedInstancesIds

The IDs of the Reserved Instances to modify.

targetConfigurations

com.amazonaws.internal.SdkInternalList<ReservedInstancesConfiguration> targetConfigurations

The configuration settings for the Reserved Instances to modify.

Class com.amazonaws.services.ec2.model.ModifyReservedInstancesResult

class ModifyReservedInstancesResult extends Object implements Serializable

Serialized Fields

reservedInstancesModificationId

String reservedInstancesModificationId

The ID for the modification.

Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeRequest

class ModifySnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The snapshot attribute to modify.

Only volume creation permissions may be modified at the customer level.

createVolumePermission

CreateVolumePermissionModifications createVolumePermission

A JSON representation of the snapshot attribute modification.

groupNames

com.amazonaws.internal.SdkInternalList<String> groupNames

The group to modify for the snapshot.

operationType

String operationType

The type of operation to perform to the attribute.

snapshotId

String snapshotId

The ID of the snapshot.

userIds

com.amazonaws.internal.SdkInternalList<String> userIds

The account ID to modify for the snapshot.

Class com.amazonaws.services.ec2.model.ModifySnapshotAttributeResult

class ModifySnapshotAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifySpotFleetRequestRequest

class ModifySpotFleetRequestRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

spotFleetRequestId

String spotFleetRequestId

The ID of the Spot fleet request.

targetCapacity

Integer targetCapacity

The size of the fleet.

Class com.amazonaws.services.ec2.model.ModifySpotFleetRequestResult

class 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

class ModifySubnetAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mapPublicIpOnLaunch

Boolean mapPublicIpOnLaunch

Specify true to indicate that instances launched into the specified subnet should be assigned public IP address.

subnetId

String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.ModifySubnetAttributeResult

class ModifySubnetAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifyVolumeAttributeRequest

class ModifyVolumeAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoEnableIO

Boolean autoEnableIO

Indicates whether the volume should be auto-enabled for I/O operations.

volumeId

String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.ModifyVolumeAttributeResult

class ModifyVolumeAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifyVpcAttributeRequest

class ModifyVpcAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.ModifyVpcAttributeResult

class ModifyVpcAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ModifyVpcEndpointRequest

class ModifyVpcEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

addRouteTableIds

com.amazonaws.internal.SdkInternalList<String> addRouteTableIds

One or more route tables IDs to associate with the endpoint.

policyDocument

String policyDocument

A policy document to attach to the endpoint. The policy must be in valid JSON format.

removeRouteTableIds

com.amazonaws.internal.SdkInternalList<String> removeRouteTableIds

One or more route table IDs to disassociate from the endpoint.

resetPolicy

Boolean resetPolicy

Specify true to reset the policy document to the default policy. The default policy allows access to the service.

vpcEndpointId

String vpcEndpointId

The ID of the endpoint.

Class com.amazonaws.services.ec2.model.ModifyVpcEndpointResult

class 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.ModifyVpcPeeringConnectionOptionsRequest

class ModifyVpcPeeringConnectionOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accepterPeeringConnectionOptions

PeeringConnectionOptionsRequest accepterPeeringConnectionOptions

The VPC peering connection options for the accepter VPC.

requesterPeeringConnectionOptions

PeeringConnectionOptionsRequest requesterPeeringConnectionOptions

The VPC peering connection options for the requester VPC.

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.ModifyVpcPeeringConnectionOptionsResult

class ModifyVpcPeeringConnectionOptionsResult extends Object implements Serializable

Serialized Fields

accepterPeeringConnectionOptions

PeeringConnectionOptions accepterPeeringConnectionOptions

Information about the VPC peering connection options for the accepter VPC.

requesterPeeringConnectionOptions

PeeringConnectionOptions requesterPeeringConnectionOptions

Information about the VPC peering connection options for the requester VPC.

Class com.amazonaws.services.ec2.model.Monitoring

class 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

class MonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.MonitorInstancesResult

class MonitorInstancesResult extends Object implements Serializable

Serialized Fields

instanceMonitorings

com.amazonaws.internal.SdkInternalList<InstanceMonitoring> instanceMonitorings

Monitoring information for one or more instances.

Class com.amazonaws.services.ec2.model.MoveAddressToVpcRequest

class MoveAddressToVpcRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publicIp

String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.MoveAddressToVpcResult

class 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

class MovingAddressStatus extends Object implements Serializable

Serialized Fields

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.

publicIp

String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.NatGateway

class NatGateway extends Object implements Serializable

Serialized Fields

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.

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

natGatewayAddresses

com.amazonaws.internal.SdkInternalList<NatGatewayAddress> natGatewayAddresses

Information about the IP addresses and network interface associated with the NAT gateway.

natGatewayId

String natGatewayId

The ID of the NAT gateway.

state

String state

The state of the NAT gateway.

• pending: The NAT gateway is being created and is not ready to process traffic.

• failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.

• available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.

• deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.

• deleted: The NAT gateway has been terminated and is no longer processing traffic.

subnetId

String subnetId

The ID of the subnet in which the NAT gateway is located.

vpcId

String vpcId

The ID of the VPC in which the NAT gateway is located.

Class com.amazonaws.services.ec2.model.NatGatewayAddress

class NatGatewayAddress extends Object implements Serializable

Serialized Fields

allocationId

String allocationId

The allocation ID of the Elastic IP address that's associated with the NAT gateway.

networkInterfaceId

String networkInterfaceId

The ID of the network interface associated with the NAT gateway.

privateIp

String privateIp

The private IP address associated with the Elastic IP address.

publicIp

String publicIp

The Elastic IP address associated with the NAT gateway.

Class com.amazonaws.services.ec2.model.NetworkAcl

class NetworkAcl extends Object implements Serializable

Serialized Fields

associations

com.amazonaws.internal.SdkInternalList<NetworkAclAssociation> associations

Any associations between the network ACL and one or more subnets

entries

com.amazonaws.internal.SdkInternalList<NetworkAclEntry> entries

One or more entries (rules) in the network ACL.

isDefault

Boolean isDefault

Indicates whether this is the default network ACL for the VPC.

networkAclId

String networkAclId

The ID of the network ACL.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the network ACL.

vpcId

String vpcId

The ID of the VPC for the network ACL.

Class com.amazonaws.services.ec2.model.NetworkAclAssociation

class 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

class NetworkAclEntry extends Object implements Serializable

Serialized Fields

cidrBlock

String cidrBlock

The network range to allow or deny, in CIDR notation.

egress

Boolean egress

Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).

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.

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.

ruleNumber

Integer ruleNumber

The rule number for the entry. ACL entries are processed in ascending order by rule number.

Class com.amazonaws.services.ec2.model.NetworkInterface

class NetworkInterface extends Object implements Serializable

Serialized Fields

association

NetworkInterfaceAssociation association

The association information for an Elastic IP associated with the network interface.

attachment

NetworkInterfaceAttachment attachment

The network interface attachment.

availabilityZone

String availabilityZone

The Availability Zone.

description

String description

A description.

groups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> groups

Any security groups for the network interface.

interfaceType

String interfaceType

The type of interface.

macAddress

String macAddress

The MAC address.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

ownerId

String ownerId

The AWS account ID of the owner of the network interface.

privateDnsName

String privateDnsName

The private DNS name.

privateIpAddress

String privateIpAddress

The IP address of the network interface within the subnet.

privateIpAddresses

com.amazonaws.internal.SdkInternalList<NetworkInterfacePrivateIpAddress> privateIpAddresses

The private IP addresses associated with 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.

sourceDestCheck

Boolean sourceDestCheck

Indicates whether traffic to or from the instance is validated.

status

String status

The status of the network interface.

subnetId

String subnetId

The ID of the subnet.

tagSet

com.amazonaws.internal.SdkInternalList<Tag> tagSet

Any tags assigned to the network interface.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.NetworkInterfaceAssociation

class NetworkInterfaceAssociation extends Object implements Serializable

Serialized Fields

allocationId

String allocationId

The allocation ID.

associationId

String associationId

The association ID.

ipOwnerId

String ipOwnerId

The ID of the Elastic IP address owner.

publicDnsName

String publicDnsName

The public DNS name.

publicIp

String publicIp

The address of the Elastic IP address bound to the network interface.

Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachment

class NetworkInterfaceAttachment extends Object implements Serializable

Serialized Fields

attachmentId

String attachmentId

The ID of the network interface attachment.

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.

deviceIndex

Integer deviceIndex

The device index of the network interface attachment on the instance.

instanceId

String instanceId

The ID of the instance.

instanceOwnerId

String instanceOwnerId

The AWS account ID of the owner of the instance.

status

String status

The attachment state.

Class com.amazonaws.services.ec2.model.NetworkInterfaceAttachmentChanges

class 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

class NetworkInterfacePrivateIpAddress extends Object implements Serializable

Serialized Fields

association

NetworkInterfaceAssociation association

The association information for an Elastic IP address associated with the network interface.

primary

Boolean primary

Indicates whether this IP address is the primary private IP address of the network interface.

privateDnsName

String privateDnsName

The private DNS name.

privateIpAddress

String privateIpAddress

The private IP address.

Class com.amazonaws.services.ec2.model.PeeringConnectionOptions

class PeeringConnectionOptions extends Object implements Serializable

Serialized Fields

allowEgressFromLocalClassicLinkToRemoteVpc

Boolean allowEgressFromLocalClassicLinkToRemoteVpc

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

allowEgressFromLocalVpcToRemoteClassicLink

Boolean allowEgressFromLocalVpcToRemoteClassicLink

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

Class com.amazonaws.services.ec2.model.PeeringConnectionOptionsRequest

class PeeringConnectionOptionsRequest extends Object implements Serializable

Serialized Fields

allowEgressFromLocalClassicLinkToRemoteVpc

Boolean allowEgressFromLocalClassicLinkToRemoteVpc

If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC via ClassicLink to instances in a peer VPC.

allowEgressFromLocalVpcToRemoteClassicLink

Boolean allowEgressFromLocalVpcToRemoteClassicLink

If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC via ClassicLink.

Class com.amazonaws.services.ec2.model.Placement

class Placement extends Object implements Serializable

Serialized Fields

affinity

String affinity

The affinity setting for the instance on the Dedicated host. This parameter is not supported for the ImportInstance command.

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

hostId

String hostId

The ID of the Dedicted host on which the instance resides. This parameter is not support for the ImportInstance command.

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.

Class com.amazonaws.services.ec2.model.PlacementGroup

class PlacementGroup extends Object implements Serializable

Serialized Fields

groupName

String groupName

The name of the placement group.

state

String state

The state of the placement group.

strategy

String strategy

The placement strategy.

Class com.amazonaws.services.ec2.model.PortRange

class 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

class PrefixList extends Object implements Serializable

Serialized Fields

cidrs

com.amazonaws.internal.SdkInternalList<String> cidrs

The IP address range of the AWS service.

prefixListId

String prefixListId

The ID of the prefix.

prefixListName

String prefixListName

The name of the prefix.

Class com.amazonaws.services.ec2.model.PrefixListId

class PrefixListId extends Object implements Serializable

Serialized Fields

prefixListId

String prefixListId

The ID of the prefix.

Class com.amazonaws.services.ec2.model.PriceSchedule

class PriceSchedule extends Object implements Serializable

Serialized Fields

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.

currencyCode

String currencyCode

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

price

Double price

The fixed price for the term.

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.

Class com.amazonaws.services.ec2.model.PriceScheduleSpecification

class PriceScheduleSpecification extends Object implements Serializable

Serialized Fields

currencyCode

String currencyCode

The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.

price

Double price

The fixed price for the term.

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.

Class com.amazonaws.services.ec2.model.PricingDetail

class PricingDetail extends Object implements Serializable

Serialized Fields

count

Integer count

The number of reservations available for the price.

price

Double price

The price per instance.

Class com.amazonaws.services.ec2.model.PrivateIpAddressSpecification

class PrivateIpAddressSpecification extends Object implements Serializable

Serialized Fields

primary

Boolean primary

Indicates whether the private IP address is the primary private IP address. Only one IP address can be designated as primary.

privateIpAddress

String privateIpAddress

The private IP addresses.

Class com.amazonaws.services.ec2.model.ProductCode

class 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

class 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

class PurchaseRequest extends Object implements Serializable

Serialized Fields

instanceCount

Integer instanceCount

The number of instances.

purchaseToken

String purchaseToken

The purchase token.

Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingRequest

class PurchaseReservedInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

reservedInstancesOfferingId

String reservedInstancesOfferingId

The ID of the Reserved Instance offering to purchase.

Class com.amazonaws.services.ec2.model.PurchaseReservedInstancesOfferingResult

class PurchaseReservedInstancesOfferingResult extends Object implements Serializable

Serialized Fields

reservedInstancesId

String reservedInstancesId

The IDs of the purchased Reserved Instances.

Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesRequest

class 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<PurchaseRequest> purchaseRequests

One or more purchase requests.

Class com.amazonaws.services.ec2.model.PurchaseScheduledInstancesResult

class PurchaseScheduledInstancesResult extends Object implements Serializable

Serialized Fields

scheduledInstanceSet

com.amazonaws.internal.SdkInternalList<ScheduledInstance> scheduledInstanceSet

Information about the Scheduled Instances.

Class com.amazonaws.services.ec2.model.RebootInstancesRequest

class RebootInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.RebootInstancesResult

class RebootInstancesResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.RecurringCharge

class RecurringCharge extends Object implements Serializable

Serialized Fields

amount

Double amount

The amount of the recurring charge.

frequency

String frequency

The frequency of the recurring charge.

Class com.amazonaws.services.ec2.model.Region

class Region extends Object implements Serializable

Serialized Fields

endpoint

String endpoint

The region service endpoint.

regionName

String regionName

The name of the region.

Class com.amazonaws.services.ec2.model.RegisterImageRequest

class RegisterImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

description

String description

A description for your AMI.

imageLocation

String imageLocation

The full path to your AMI manifest in Amazon S3 storage.

kernelId

String kernelId

The ID of the kernel.

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(_)

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

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.

virtualizationType

String virtualizationType

The type of virtualization.

Default: paravirtual

Class com.amazonaws.services.ec2.model.RegisterImageResult

class RegisterImageResult extends Object implements Serializable

Serialized Fields

imageId

String imageId

The ID of the newly registered AMI.

Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionRequest

class RejectVpcPeeringConnectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.RejectVpcPeeringConnectionResult

class 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

class ReleaseAddressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allocationId

String allocationId

[EC2-VPC] The allocation ID. Required for EC2-VPC.

publicIp

String publicIp

[EC2-Classic] The Elastic IP address. Required for EC2-Classic.

Class com.amazonaws.services.ec2.model.ReleaseAddressResult

class ReleaseAddressResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ReleaseHostsRequest

class ReleaseHostsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hostIds

com.amazonaws.internal.SdkInternalList<String> hostIds

The IDs of the Dedicated hosts you want to release.

Class com.amazonaws.services.ec2.model.ReleaseHostsResult

class ReleaseHostsResult extends Object implements Serializable

Serialized Fields

successful

com.amazonaws.internal.SdkInternalList<String> successful

The IDs of the Dedicated hosts that were successfully released.

unsuccessful

com.amazonaws.internal.SdkInternalList<UnsuccessfulItem> unsuccessful

The IDs of the Dedicated hosts that could not be released, including an error message.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclAssociationRequest

class 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

class ReplaceNetworkAclAssociationResult extends Object implements Serializable

Serialized Fields

newAssociationId

String newAssociationId

The ID of the new association.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclEntryRequest

class ReplaceNetworkAclEntryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrBlock

String cidrBlock

The network range to allow or deny, in CIDR notation.

egress

Boolean egress

Indicates whether to replace the egress rule.

Default: If no value is specified, we replace the ingress rule.

icmpTypeCode

IcmpTypeCode icmpTypeCode

ICMP protocol: The ICMP type and code. Required if specifying 1 (ICMP) for the protocol.

networkAclId

String networkAclId

The ID of the ACL.

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.

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.

ruleNumber

Integer ruleNumber

The rule number of the entry to replace.

Class com.amazonaws.services.ec2.model.ReplaceNetworkAclEntryResult

class ReplaceNetworkAclEntryResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ReplaceRouteRequest

class ReplaceRouteRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

natGatewayId

String natGatewayId

The ID of a NAT gateway.

networkInterfaceId

String networkInterfaceId

The ID of a network interface.

routeTableId

String routeTableId

The ID of the route table.

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of a VPC peering connection.

Class com.amazonaws.services.ec2.model.ReplaceRouteResult

class ReplaceRouteResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ReplaceRouteTableAssociationRequest

class 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

class ReplaceRouteTableAssociationResult extends Object implements Serializable

Serialized Fields

newAssociationId

String newAssociationId

The ID of the new association.

Class com.amazonaws.services.ec2.model.ReportInstanceStatusRequest

class ReportInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

Descriptive text about the health state of your instance.

endTime

Date endTime

The time at which the reported instance health state ended.

instances

com.amazonaws.internal.SdkInternalList<String> instances

One or more instances.

reasonCodes

com.amazonaws.internal.SdkInternalList<String> 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]

startTime

Date startTime

The time at which the reported instance health state began.

status

String status

The status of all instances listed.

Class com.amazonaws.services.ec2.model.ReportInstanceStatusResult

class ReportInstanceStatusResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.RequestSpotFleetRequest

class RequestSpotFleetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

spotFleetRequestConfig

SpotFleetRequestConfigData spotFleetRequestConfig

The configuration for the Spot fleet request.

Class com.amazonaws.services.ec2.model.RequestSpotFleetResult

class RequestSpotFleetResult extends Object implements Serializable

Serialized Fields

spotFleetRequestId

String spotFleetRequestId

The ID of the Spot fleet request.

Class com.amazonaws.services.ec2.model.RequestSpotInstancesRequest

class RequestSpotInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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

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

launchSpecification

LaunchSpecification launchSpecification

spotPrice

String spotPrice

The maximum hourly price (bid) for any Spot instance launched to fulfill the request.

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.

Class com.amazonaws.services.ec2.model.RequestSpotInstancesResult

class RequestSpotInstancesResult extends Object implements Serializable

Serialized Fields

spotInstanceRequests

com.amazonaws.internal.SdkInternalList<SpotInstanceRequest> spotInstanceRequests

One or more Spot instance requests.

Class com.amazonaws.services.ec2.model.Reservation

class Reservation extends Object implements Serializable

Serialized Fields

groupNames

com.amazonaws.internal.SdkInternalList<String> groupNames

One or more security group names.

groups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> groups

[EC2-Classic only] One or more security groups.

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

One or more instances.

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

reservationId

String reservationId

The ID of the reservation.

Class com.amazonaws.services.ec2.model.ReservedInstanceLimitPrice

class 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

class ReservedInstances extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone in which the Reserved Instance can be used.

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.

duration

Long duration

The duration of the Reserved Instance, in seconds.

end

Date end

The time when the Reserved Instance expires.

fixedPrice

Float fixedPrice

The purchase price of the Reserved Instance.

instanceCount

Integer instanceCount

The number of reservations purchased.

instanceTenancy

String instanceTenancy

The tenancy of the instance.

instanceType

String instanceType

The instance type on which the Reserved Instance can be used.

offeringType

String offeringType

The Reserved Instance offering type.

productDescription

String productDescription

The Reserved Instance product platform description.

recurringCharges

com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

The recurring charge tag assigned to the resource.

reservedInstancesId

String reservedInstancesId

The ID of the Reserved Instance.

start

Date start

The date and time the Reserved Instance started.

state

String state

The state of the Reserved Instance purchase.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the resource.

usagePrice

Float usagePrice

The usage price of the Reserved Instance, per hour.

Class com.amazonaws.services.ec2.model.ReservedInstancesConfiguration

class ReservedInstancesConfiguration extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone for the modified Reserved Instances.

instanceCount

Integer instanceCount

The number of modified Reserved Instances.

instanceType

String instanceType

The instance type for the modified Reserved Instances.

platform

String platform

The network platform of the modified Reserved Instances, which is either EC2-Classic or EC2-VPC.

Class com.amazonaws.services.ec2.model.ReservedInstancesId

class ReservedInstancesId extends Object implements Serializable

Serialized Fields

reservedInstancesId

String reservedInstancesId

The ID of the Reserved Instance.

Class com.amazonaws.services.ec2.model.ReservedInstancesListing

class ReservedInstancesListing extends Object implements Serializable

Serialized Fields

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.

createDate

Date createDate

The time the listing was created.

instanceCounts

com.amazonaws.internal.SdkInternalList<InstanceCount> instanceCounts

The number of instances in this state.

priceSchedules

com.amazonaws.internal.SdkInternalList<PriceSchedule> priceSchedules

The price of the Reserved Instance listing.

reservedInstancesId

String reservedInstancesId

The ID of the Reserved Instance.

reservedInstancesListingId

String reservedInstancesListingId

The ID of the Reserved Instance 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.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the resource.

updateDate

Date updateDate

The last modified timestamp of the listing.

Class com.amazonaws.services.ec2.model.ReservedInstancesModification

class ReservedInstancesModification extends Object implements Serializable

Serialized Fields

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.

createDate

Date createDate

The time when the modification request was created.

effectiveDate

Date effectiveDate

The time for the modification to become effective.

modificationResults

com.amazonaws.internal.SdkInternalList<ReservedInstancesModificationResult> modificationResults

Contains target configurations along with their corresponding new Reserved Instance IDs.

reservedInstancesIds

com.amazonaws.internal.SdkInternalList<ReservedInstancesId> reservedInstancesIds

The IDs of one or more Reserved Instances.

reservedInstancesModificationId

String reservedInstancesModificationId

A unique ID for the Reserved Instance modification.

status

String status

The status of the Reserved Instances modification request.

statusMessage

String statusMessage

The reason for the status.

updateDate

Date updateDate

The time when the modification request was last updated.

Class com.amazonaws.services.ec2.model.ReservedInstancesModificationResult

class 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

class ReservedInstancesOffering extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone in which the Reserved Instance can be used.

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.

duration

Long duration

The duration of the Reserved Instance, in seconds.

fixedPrice

Float fixedPrice

The purchase price of the Reserved Instance.

instanceTenancy

String instanceTenancy

The tenancy of the instance.

instanceType

String instanceType

The instance type on which the Reserved Instance can be used.

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.

offeringType

String offeringType

The Reserved Instance offering type.

pricingDetails

com.amazonaws.internal.SdkInternalList<PricingDetail> pricingDetails

The pricing details of the Reserved Instance offering.

productDescription

String productDescription

The Reserved Instance product platform description.

recurringCharges

com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

The recurring charge tag assigned to the resource.

reservedInstancesOfferingId

String reservedInstancesOfferingId

The ID of the Reserved Instance offering.

usagePrice

Float usagePrice

The usage price of the Reserved Instance, per hour.

Class com.amazonaws.services.ec2.model.ResetImageAttributeRequest

class ResetImageAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The attribute to reset (currently you can only reset the launch permission attribute).

imageId

String imageId

The ID of the AMI.

Class com.amazonaws.services.ec2.model.ResetImageAttributeResult

class ResetImageAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ResetInstanceAttributeRequest

class ResetInstanceAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The attribute to reset.

You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.

instanceId

String instanceId

The ID of the instance.

Class com.amazonaws.services.ec2.model.ResetInstanceAttributeResult

class ResetInstanceAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ResetNetworkInterfaceAttributeRequest

class 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.ResetNetworkInterfaceAttributeResult

class ResetNetworkInterfaceAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.ResetSnapshotAttributeRequest

class ResetSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attribute

String attribute

The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.

snapshotId

String snapshotId

The ID of the snapshot.

Class com.amazonaws.services.ec2.model.ResetSnapshotAttributeResult

class ResetSnapshotAttributeResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.RestoreAddressToClassicRequest

class RestoreAddressToClassicRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

publicIp

String publicIp

The Elastic IP address.

Class com.amazonaws.services.ec2.model.RestoreAddressToClassicResult

class RestoreAddressToClassicResult extends Object implements Serializable

Serialized Fields

publicIp

String publicIp

The Elastic IP address.

status

String status

The move status for the IP address.

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressRequest

class RevokeSecurityGroupEgressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

String cidrIp

The CIDR IP address range. We recommend that you specify the CIDR range 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.

groupId

String groupId

The ID of the security group.

ipPermissions

com.amazonaws.internal.SdkInternalList<IpPermission> ipPermissions

A set of IP permissions. You can't specify a destination security group and a CIDR IP address range.

ipProtocol

String ipProtocol

The IP protocol name or number. We recommend that you specify the protocol in a set of IP permissions instead.

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.

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.

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupEgressResult

class RevokeSecurityGroupEgressResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressRequest

class RevokeSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cidrIp

String cidrIp

The CIDR IP address range. You can't specify this parameter when specifying a source security group.

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.

groupId

String groupId

The ID of the security group. Required for a security group in a nondefault VPC.

groupName

String groupName

[EC2-Classic, default VPC] The name of the security group.

ipPermissions

com.amazonaws.internal.SdkInternalList<IpPermission> ipPermissions

A set of IP permissions. You can't specify a source security group and a CIDR IP address range.

ipProtocol

String ipProtocol

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.

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.

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.

Class com.amazonaws.services.ec2.model.RevokeSecurityGroupIngressResult

class RevokeSecurityGroupIngressResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.Route

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

natGatewayId

String natGatewayId

The ID of a NAT gateway.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

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.

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

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.RouteTable

class RouteTable extends Object implements Serializable

Serialized Fields

associations

com.amazonaws.internal.SdkInternalList<RouteTableAssociation> associations

The associations between the route table and one or more subnets.

propagatingVgws

com.amazonaws.internal.SdkInternalList<PropagatingVgw> propagatingVgws

Any virtual private gateway (VGW) propagating routes.

routes

com.amazonaws.internal.SdkInternalList<Route> routes

The routes in the route table.

routeTableId

String routeTableId

The ID of the route table.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the route table.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.RouteTableAssociation

class RouteTableAssociation extends Object implements Serializable

Serialized Fields

main

Boolean main

Indicates whether this is the main route table.

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.

Class com.amazonaws.services.ec2.model.RunInstancesRequest

class RunInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalInfo

String additionalInfo

Reserved.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> blockDeviceMappings

The block device mapping.

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

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

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

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

The IAM instance profile.

imageId

String imageId

The ID of the AMI, which you can get by calling DescribeImages.

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

instanceType

String instanceType

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

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.

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.

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.

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.

monitoring

Boolean monitoring

The monitoring for the instance.

networkInterfaces

com.amazonaws.internal.SdkInternalList<InstanceNetworkInterfaceSpecification> networkInterfaces

One or more network interfaces.

placement

Placement placement

The placement for the instance.

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.

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.

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> securityGroupIds

One or more security group IDs. You can create a security group using CreateSecurityGroup.

Default: Amazon EC2 uses the default security group.

securityGroups

com.amazonaws.internal.SdkInternalList<String> 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.

subnetId

String subnetId

[EC2-VPC] The ID of the subnet to launch the instance into.

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.

Class com.amazonaws.services.ec2.model.RunInstancesResult

class RunInstancesResult extends Object implements Serializable

Serialized Fields

reservation

Reservation reservation

Describes a reservation.

Class com.amazonaws.services.ec2.model.RunScheduledInstancesRequest

class 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

launchSpecification

ScheduledInstancesLaunchSpecification launchSpecification

The launch specification.

scheduledInstanceId

String scheduledInstanceId

The Scheduled Instance ID.

Class com.amazonaws.services.ec2.model.RunScheduledInstancesResult

class RunScheduledInstancesResult extends Object implements Serializable

Serialized Fields

instanceIdSet

com.amazonaws.internal.SdkInternalList<String> instanceIdSet

The IDs of the newly launched instances.

Class com.amazonaws.services.ec2.model.S3Storage

class S3Storage extends Object implements Serializable

Serialized Fields

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.

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.

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

class ScheduledInstance extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone.

createDate

Date createDate

The date when the Scheduled Instance was purchased.

hourlyPrice

String hourlyPrice

The hourly price for a single instance.

instanceCount

Integer instanceCount

The number of instances.

instanceType

String instanceType

The instance type.

networkPlatform

String networkPlatform

The network platform (EC2-Classic or EC2-VPC).

nextSlotStartTime

Date nextSlotStartTime

The time for the next schedule to start.

platform

String platform

The platform (Linux/UNIX or Windows).

previousSlotEndTime

Date previousSlotEndTime

The time that the previous schedule ended or will end.

recurrence

ScheduledInstanceRecurrence recurrence

The schedule recurrence.

scheduledInstanceId

String scheduledInstanceId

The Scheduled Instance ID.

slotDurationInHours

Integer slotDurationInHours

The number of hours in the schedule.

termEndDate

Date termEndDate

The end date for the Scheduled Instance.

termStartDate

Date termStartDate

The start date for the Scheduled Instance.

totalScheduledInstanceHours

Integer totalScheduledInstanceHours

The total number of hours for a single instance for the entire term.

Class com.amazonaws.services.ec2.model.ScheduledInstanceAvailability

class ScheduledInstanceAvailability extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone.

availableInstanceCount

Integer availableInstanceCount

The number of available instances.

firstSlotStartTime

Date firstSlotStartTime

The time period for the first schedule to start.

hourlyPrice

String hourlyPrice

The hourly price for a single instance.

instanceType

String instanceType

The instance type. You can specify one of the C3, C4, M4, or R3 instance types.

maxTermDurationInDays

Integer maxTermDurationInDays

The maximum term. The only possible value is 365 days.

minTermDurationInDays

Integer minTermDurationInDays

The minimum term. The only possible value is 365 days.

networkPlatform

String networkPlatform

The network platform (EC2-Classic or EC2-VPC).

platform

String platform

The platform (Linux/UNIX or Windows).

purchaseToken

String purchaseToken

The purchase token. This token expires in two hours.

recurrence

ScheduledInstanceRecurrence recurrence

The schedule recurrence.

slotDurationInHours

Integer slotDurationInHours

The number of hours in the schedule.

totalScheduledInstanceHours

Integer totalScheduledInstanceHours

The total number of hours for a single instance for the entire term.

Class com.amazonaws.services.ec2.model.ScheduledInstanceRecurrence

class 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<Integer> 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

class 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<Integer> 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

class ScheduledInstancesBlockDeviceMapping extends Object implements Serializable

Serialized Fields

deviceName

String deviceName

The device name exposed to the instance (for example, /dev/sdh or xvdh).

ebs

ScheduledInstancesEbs ebs

Parameters used to set up EBS volumes automatically when the instance is launched.

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.

Class com.amazonaws.services.ec2.model.ScheduledInstancesEbs

class ScheduledInstancesEbs extends Object implements Serializable

Serialized Fields

deleteOnTermination

Boolean deleteOnTermination

Indicates whether the volume is deleted on instance termination.

encrypted

Boolean encrypted

Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.

iops

Integer iops

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information about gp2 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 io1volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

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.

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

Class com.amazonaws.services.ec2.model.ScheduledInstancesIamInstanceProfile

class ScheduledInstancesIamInstanceProfile extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN).

name

String name

The name.

Class com.amazonaws.services.ec2.model.ScheduledInstancesLaunchSpecification

class ScheduledInstancesLaunchSpecification extends Object implements Serializable

Serialized Fields

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<ScheduledInstancesBlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

ebsOptimized

Boolean ebsOptimized

Indicates whether the instances are 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

iamInstanceProfile

ScheduledInstancesIamInstanceProfile iamInstanceProfile

The IAM instance profile.

imageId

String imageId

The ID of the Amazon Machine Image (AMI).

instanceType

String instanceType

The instance type.

kernelId

String kernelId

The ID of the kernel.

keyName

String keyName

The name of the key pair.

monitoring

ScheduledInstancesMonitoring monitoring

Enable or disable monitoring for the instances.

networkInterfaces

com.amazonaws.internal.SdkInternalList<ScheduledInstancesNetworkInterface> networkInterfaces

One or more network interfaces.

placement

ScheduledInstancesPlacement placement

The placement information.

ramdiskId

String ramdiskId

The ID of the RAM disk.

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> securityGroupIds

The IDs of one or more security groups.

subnetId

String subnetId

The ID of the subnet in which to launch the instances.

userData

String userData

The base64-encoded MIME user data.

Class com.amazonaws.services.ec2.model.ScheduledInstancesMonitoring

class ScheduledInstancesMonitoring extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Indicates whether monitoring is enabled.

Class com.amazonaws.services.ec2.model.ScheduledInstancesNetworkInterface

class ScheduledInstancesNetworkInterface extends Object implements Serializable

Serialized Fields

associatePublicIpAddress

Boolean associatePublicIpAddress

Indicates whether to assign a public IP address to instances launched 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.

deleteOnTermination

Boolean deleteOnTermination

Indicates whether to delete the interface when the instance is terminated.

description

String description

The description.

deviceIndex

Integer deviceIndex

The index of the device for the network interface attachment.

groups

com.amazonaws.internal.SdkInternalList<String> groups

The IDs of one or more security groups.

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

privateIpAddress

String privateIpAddress

The IP address of the network interface within the subnet.

privateIpAddressConfigs

com.amazonaws.internal.SdkInternalList<ScheduledInstancesPrivateIpAddressConfig> privateIpAddressConfigs

The private IP addresses.

secondaryPrivateIpAddressCount

Integer secondaryPrivateIpAddressCount

The number of secondary private IP addresses.

subnetId

String subnetId

The ID of the subnet.

Class com.amazonaws.services.ec2.model.ScheduledInstancesPlacement

class ScheduledInstancesPlacement extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone.

groupName

String groupName

The name of the placement group.

Class com.amazonaws.services.ec2.model.ScheduledInstancesPrivateIpAddressConfig

class ScheduledInstancesPrivateIpAddressConfig extends Object implements Serializable

Serialized Fields

primary

Boolean primary

Indicates whether this is a primary IP address. Otherwise, this is a secondary IP address.

privateIpAddress

String privateIpAddress

The IP address.

Class com.amazonaws.services.ec2.model.SecurityGroup

class SecurityGroup extends Object implements Serializable

Serialized Fields

description

String description

A description of the security group.

groupId

String groupId

The ID of the security group.

groupName

String groupName

The name of the security group.

ipPermissions

com.amazonaws.internal.SdkInternalList<IpPermission> ipPermissions

One or more inbound rules associated with the security group.

ipPermissionsEgress

com.amazonaws.internal.SdkInternalList<IpPermission> ipPermissionsEgress

[EC2-VPC] One or more outbound rules associated with the security group.

ownerId

String ownerId

The AWS account ID of the owner of the security group.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the security group.

vpcId

String vpcId

[EC2-VPC] The ID of the VPC for the security group.

Class com.amazonaws.services.ec2.model.SecurityGroupReference

class SecurityGroupReference extends Object implements Serializable

Serialized Fields

groupId

String groupId

The ID of your security group.

referencingVpcId

String referencingVpcId

The ID of the VPC with the referencing security group.

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.SlotDateTimeRangeRequest

class SlotDateTimeRangeRequest extends Object implements Serializable

Serialized Fields

earliestTime

Date earliestTime

The earliest date and time, in UTC, for the Scheduled Instance to start.

latestTime

Date latestTime

The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.

Class com.amazonaws.services.ec2.model.SlotStartTimeRangeRequest

class SlotStartTimeRangeRequest extends Object implements Serializable

Serialized Fields

earliestTime

Date earliestTime

The earliest date and time, in UTC, for the Scheduled Instance to start.

latestTime

Date latestTime

The latest date and time, in UTC, for the Scheduled Instance to start.

Class com.amazonaws.services.ec2.model.Snapshot

class Snapshot extends Object implements Serializable

Serialized Fields

dataEncryptionKeyId

String dataEncryptionKeyId

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by the DescribeSnapshots API operation.

description

String description

The description for the snapshot.

encrypted

Boolean encrypted

Indicates whether the snapshot is encrypted.

kmsKeyId

String kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.

ownerAlias

String ownerAlias

The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.

ownerId

String ownerId

The AWS account ID of the EBS snapshot owner.

progress

String progress

The progress of the snapshot, as a percentage.

snapshotId

String snapshotId

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

startTime

Date startTime

The time stamp when the snapshot was initiated.

state

String state

The snapshot state.

stateMessage

String stateMessage

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by the DescribeSnapshots API operation.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the snapshot.

volumeId

String volumeId

The ID of the volume that was used to create the snapshot.

volumeSize

Integer volumeSize

The size of the volume, in GiB.

Class com.amazonaws.services.ec2.model.SnapshotDetail

class SnapshotDetail extends Object implements Serializable

Serialized Fields

description

String description

A description for the snapshot.

deviceName

String deviceName

The block device mapping for the snapshot.

diskImageSize

Double diskImageSize

The size of the disk in the snapshot, in GiB.

format

String format

The format of the disk image from which the snapshot is created.

progress

String progress

The percentage of progress for the task.

snapshotId

String snapshotId

The snapshot ID of the disk being imported.

status

String status

A brief status of the snapshot creation.

statusMessage

String statusMessage

A detailed status message for the snapshot creation.

url

String url

The URL used to access the disk image.

userBucket

UserBucketDetails userBucket

The S3 bucket for the disk image.

Class com.amazonaws.services.ec2.model.SnapshotDiskContainer

class SnapshotDiskContainer extends Object implements Serializable

Serialized Fields

description

String description

The description of the disk image being imported.

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. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).

userBucket

UserBucket userBucket

The S3 bucket for the disk image.

Class com.amazonaws.services.ec2.model.SnapshotTaskDetail

class SnapshotTaskDetail extends Object implements Serializable

Serialized Fields

description

String description

The description of the snapshot.

diskImageSize

Double diskImageSize

The size of the disk in the snapshot, in GiB.

format

String format

The format of the disk image from which the snapshot is created.

progress

String progress

The percentage of completion for the import snapshot task.

snapshotId

String snapshotId

The snapshot ID of the disk being imported.

status

String status

A brief status for the import snapshot task.

statusMessage

String statusMessage

A detailed status message for the import snapshot task.

url

String url

The URL of the disk image from which the snapshot is created.

userBucket

UserBucketDetails userBucket

The S3 bucket for the disk image.

Class com.amazonaws.services.ec2.model.SpotDatafeedSubscription

class SpotDatafeedSubscription extends Object implements Serializable

Serialized Fields

bucket

String bucket

The Amazon S3 bucket where the Spot instance data feed is located.

fault

SpotInstanceStateFault fault

The fault codes for the Spot instance request, if any.

ownerId

String ownerId

The AWS account ID of the account.

prefix

String prefix

The prefix that is prepended to data feed files.

state

String state

The state of the Spot instance data feed subscription.

Class com.amazonaws.services.ec2.model.SpotFleetLaunchSpecification

class SpotFleetLaunchSpecification extends Object implements Serializable

Serialized Fields

addressingType

String addressingType

Deprecated.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> blockDeviceMappings

One or more block device mapping entries.

ebsOptimized

Boolean ebsOptimized

Indicates whether the instances are 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

iamInstanceProfile

IamInstanceProfileSpecification iamInstanceProfile

The IAM instance profile.

imageId

String imageId

The ID of the AMI.

instanceType

String instanceType

The instance type.

kernelId

String kernelId

The ID of the kernel.

keyName

String keyName

The name of the key pair.

monitoring

SpotFleetMonitoring monitoring

Enable or disable monitoring for the instances.

networkInterfaces

com.amazonaws.internal.SdkInternalList<InstanceNetworkInterfaceSpecification> networkInterfaces

One or more network interfaces.

placement

SpotPlacement placement

The placement information.

ramdiskId

String ramdiskId

The ID of the RAM disk.

securityGroups

com.amazonaws.internal.SdkInternalList<GroupIdentifier> securityGroups

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.

spotPrice

String spotPrice

The bid price per unit hour for the specified instance type. If this value is not specified, the default is the Spot bid price specified for the fleet. To determine the bid price per unit hour, divide the Spot bid price by the value of WeightedCapacity.

subnetId

String subnetId

The ID of the subnet in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-a61dafcf, subnet-65ea5f08".

userData

String userData

The Base64-encoded MIME user data to make available to the instances.

weightedCapacity

Double weightedCapacity

The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).

If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.

Class com.amazonaws.services.ec2.model.SpotFleetMonitoring

class SpotFleetMonitoring extends Object implements Serializable

Serialized Fields

enabled

Boolean enabled

Enables monitoring for the instance.

Default: false

Class com.amazonaws.services.ec2.model.SpotFleetRequestConfig

class SpotFleetRequestConfig extends Object implements Serializable

Serialized Fields

createTime

Date createTime

The creation date and time of the request.

spotFleetRequestConfig

SpotFleetRequestConfigData spotFleetRequestConfig

Information about the configuration of the Spot fleet request.

spotFleetRequestId

String spotFleetRequestId

The ID of the Spot fleet request.

spotFleetRequestState

String spotFleetRequestState

The state of the Spot fleet request.

Class com.amazonaws.services.ec2.model.SpotFleetRequestConfigData

class SpotFleetRequestConfigData extends Object implements Serializable

Serialized Fields

allocationStrategy

String allocationStrategy

Indicates how to allocate the target capacity across the Spot pools specified by the Spot fleet request. The default is lowestPrice.

clientToken

String clientToken

A unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

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.

iamFleetRole

String iamFleetRole

Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set terminateInstancesWithExpiration.

launchSpecifications

com.amazonaws.internal.SdkInternalList<SpotFleetLaunchSpecification> launchSpecifications

Information about the launch specifications for the Spot fleet request.

spotPrice

String spotPrice

The bid price per unit hour.

targetCapacity

Integer targetCapacity

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O.

terminateInstancesWithExpiration

Boolean terminateInstancesWithExpiration

Indicates whether running Spot instances should be terminated when the Spot fleet request expires.

validFrom

Date validFrom

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

validUntil

Date validUntil

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request.

Class com.amazonaws.services.ec2.model.SpotInstanceRequest

class SpotInstanceRequest extends Object implements Serializable

Serialized Fields

actualBlockHourlyPrice

String actualBlockHourlyPrice

If you specified a duration and your Spot instance request was fulfilled, this is the fixed hourly price in effect for the Spot instance while it runs.

availabilityZoneGroup

String availabilityZoneGroup

The Availability Zone group. If you specify the same Availability Zone group for all Spot instance requests, all Spot instances are launched in the same Availability Zone.

blockDurationMinutes

Integer blockDurationMinutes

The duration for the Spot instance, in minutes.

createTime

Date createTime

The date and time when the Spot instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

fault

SpotInstanceStateFault fault

The fault codes for the Spot instance request, if any.

instanceId

String instanceId

The instance ID, if an instance has been launched to fulfill the Spot instance request.

launchedAvailabilityZone

String launchedAvailabilityZone

The Availability Zone in which the bid is launched.

launchGroup

String launchGroup

The instance launch group. Launch groups are Spot instances that launch together and terminate together.

launchSpecification

LaunchSpecification launchSpecification

Additional information for launching instances.

productDescription

String productDescription

The product description associated with the Spot instance.

spotInstanceRequestId

String spotInstanceRequestId

The ID of the Spot instance request.

spotPrice

String spotPrice

The maximum hourly price (bid) for the Spot instance launched to fulfill the request.

state

String state

The state of the Spot instance request. Spot bid status information can help you track your Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.

status

SpotInstanceStatus status

The status code and status message describing the Spot instance request.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the resource.

type

String type

The Spot instance request type.

validFrom

Date validFrom

The start date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The request becomes active at this date and time.

validUntil

Date validUntil

The end date of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). If this is a one-time request, it 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 is reached.

Class com.amazonaws.services.ec2.model.SpotInstanceStateFault

class SpotInstanceStateFault extends Object implements Serializable

Serialized Fields

code

String code

The reason code for the Spot instance state change.

message

String message

The message for the Spot instance state change.

Class com.amazonaws.services.ec2.model.SpotInstanceStatus

class SpotInstanceStatus extends Object implements Serializable

Serialized Fields

code

String code

The status code. For a list of status codes, see Spot Bid Status Codes in the Amazon Elastic Compute Cloud User Guide.

message

String message

The description for the status code.

updateTime

Date updateTime

The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.SpotPlacement

class SpotPlacement extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone.

[Spot fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".

groupName

String groupName

The name of the placement group (for cluster instances).

Class com.amazonaws.services.ec2.model.SpotPrice

class SpotPrice extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone.

instanceType

String instanceType

The instance type.

productDescription

String productDescription

A general description of the AMI.

spotPrice

String spotPrice

The maximum price (bid) that you are willing to pay for a Spot instance.

timestamp

Date timestamp

The date and time the request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

Class com.amazonaws.services.ec2.model.StaleIpPermission

class StaleIpPermission extends Object implements Serializable

Serialized Fields

fromPort

Integer fromPort

The start of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

ipProtocol

String ipProtocol

The IP protocol name (for tcp, udp, and icmp) or number (see Protocol Numbers).

ipRanges

com.amazonaws.internal.SdkInternalList<String> ipRanges

One or more IP ranges. Not applicable for stale security group rules.

prefixListIds

com.amazonaws.internal.SdkInternalList<String> prefixListIds

One or more prefix list IDs for an AWS service. Not applicable for stale security group rules.

toPort

Integer toPort

The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types.

userIdGroupPairs

com.amazonaws.internal.SdkInternalList<UserIdGroupPair> userIdGroupPairs

One or more security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.

Class com.amazonaws.services.ec2.model.StaleSecurityGroup

class StaleSecurityGroup extends Object implements Serializable

Serialized Fields

description

String description

The description of the security group.

groupId

String groupId

The ID of the security group.

groupName

String groupName

The name of the security group.

staleIpPermissions

com.amazonaws.internal.SdkInternalList<StaleIpPermission> staleIpPermissions

Information about the stale inbound rules in the security group.

staleIpPermissionsEgress

com.amazonaws.internal.SdkInternalList<StaleIpPermission> staleIpPermissionsEgress

Information about the stale outbound rules in the security group.

vpcId

String vpcId

The ID of the VPC for the security group.

Class com.amazonaws.services.ec2.model.StartInstancesRequest

class StartInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

additionalInfo

String additionalInfo

Reserved.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.StartInstancesResult

class StartInstancesResult extends Object implements Serializable

Serialized Fields

startingInstances

com.amazonaws.internal.SdkInternalList<InstanceStateChange> startingInstances

Information about one or more started instances.

Class com.amazonaws.services.ec2.model.StateReason

class StateReason extends Object implements Serializable

Serialized Fields

code

String code

The reason code for the state change.

message

String message

The message for the state change.

• Server.SpotInstanceTermination: A Spot instance was terminated due to an increase in the market price.

• Server.InternalError: An internal error occurred during instance launch, resulting in termination.

• Server.InsufficientInstanceCapacity: There was insufficient instance capacity to satisfy the launch request.

• Client.InternalError: A client error caused the instance to terminate on launch.

• Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.

• Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

• Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your limits.

• Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

Class com.amazonaws.services.ec2.model.StopInstancesRequest

class StopInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

force

Boolean force

Forces the instances to stop. The instances do not 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. This option is not recommended for Windows instances.

Default: false

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.StopInstancesResult

class StopInstancesResult extends Object implements Serializable

Serialized Fields

stoppingInstances

com.amazonaws.internal.SdkInternalList<InstanceStateChange> stoppingInstances

Information about one or more stopped instances.

Class com.amazonaws.services.ec2.model.Storage

class Storage extends Object implements Serializable

Serialized Fields

s3

S3Storage s3

An Amazon S3 storage location.

Class com.amazonaws.services.ec2.model.Subnet

class Subnet extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone of the subnet.

availableIpAddressCount

Integer availableIpAddressCount

The number of unused IP addresses in the subnet. Note that the IP addresses for any stopped instances are considered unavailable.

cidrBlock

String cidrBlock

The CIDR block assigned to the subnet.

defaultForAz

Boolean defaultForAz

Indicates whether this is the default subnet for the Availability Zone.

mapPublicIpOnLaunch

Boolean mapPublicIpOnLaunch

Indicates whether instances launched in this subnet receive a public IP address.

state

String state

The current state of the subnet.

subnetId

String subnetId

The ID of the subnet.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the subnet.

vpcId

String vpcId

The ID of the VPC the subnet is in.

Class com.amazonaws.services.ec2.model.Tag

class Tag extends Object implements Serializable

Serialized Fields

key

String key

The key of the tag.

Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:

value

String value

The value of the tag.

Constraints: Tag values are case-sensitive and accept a maximum of 255 Unicode characters.

Class com.amazonaws.services.ec2.model.TagDescription

class TagDescription extends Object implements Serializable

Serialized Fields

key

String key

The tag key.

resourceId

String resourceId

The ID of the resource. For example, ami-1a2b3c4d.

resourceType

String resourceType

The resource type.

value

String value

The tag value.

Class com.amazonaws.services.ec2.model.TerminateInstancesRequest

class TerminateInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.TerminateInstancesResult

class TerminateInstancesResult extends Object implements Serializable

Serialized Fields

terminatingInstances

com.amazonaws.internal.SdkInternalList<InstanceStateChange> terminatingInstances

Information about one or more terminated instances.

Class com.amazonaws.services.ec2.model.UnassignPrivateIpAddressesRequest

class UnassignPrivateIpAddressesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

networkInterfaceId

String networkInterfaceId

The ID of the network interface.

privateIpAddresses

com.amazonaws.internal.SdkInternalList<String> privateIpAddresses

The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.

Class com.amazonaws.services.ec2.model.UnassignPrivateIpAddressesResult

class UnassignPrivateIpAddressesResult extends Object implements Serializable

Class com.amazonaws.services.ec2.model.UnmonitorInstancesRequest

class UnmonitorInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

One or more instance IDs.

Class com.amazonaws.services.ec2.model.UnmonitorInstancesResult

class UnmonitorInstancesResult extends Object implements Serializable

Serialized Fields

instanceMonitorings

com.amazonaws.internal.SdkInternalList<InstanceMonitoring> instanceMonitorings

Monitoring information for one or more instances.

Class com.amazonaws.services.ec2.model.UnsuccessfulItem

class UnsuccessfulItem extends Object implements Serializable

Serialized Fields

error

UnsuccessfulItemError error

Information about the error.

resourceId

String resourceId

The ID of the resource.

Class com.amazonaws.services.ec2.model.UnsuccessfulItemError

class UnsuccessfulItemError extends Object implements Serializable

Serialized Fields

code

String code

The error code.

message

String message

The error message accompanying the error code.

Class com.amazonaws.services.ec2.model.UserBucket

class UserBucket extends Object implements Serializable

Serialized Fields

s3Bucket

String s3Bucket

The name of the S3 bucket where the disk image is located.

s3Key

String s3Key

The file name of the disk image.

Class com.amazonaws.services.ec2.model.UserBucketDetails

class UserBucketDetails extends Object implements Serializable

Serialized Fields

s3Bucket

String s3Bucket

The S3 bucket from which the disk image was created.

s3Key

String s3Key

The file name of the disk image.

Class com.amazonaws.services.ec2.model.UserData

class UserData extends Object implements Serializable

Serialized Fields

data

String data

The Base64-encoded MIME user data for the instance.

Class com.amazonaws.services.ec2.model.UserIdGroupPair

class UserIdGroupPair extends Object implements Serializable

Serialized Fields

groupId

String groupId

The ID of the security group.

groupName

String groupName

The name of the security group. In a request, use this parameter for a security group in EC2-Classic or a default VPC only. For a security group in a nondefault VPC, use the security group ID.

peeringStatus

String peeringStatus

The status of a VPC peering connection, if applicable.

userId

String userId

The ID of an AWS account. For a referenced security group in another VPC, the account ID of the referenced security group is returned.

[EC2-Classic] Required when adding or removing rules that reference a security group in another AWS account.

vpcId

String vpcId

The ID of the VPC for the referenced security group, if applicable.

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection, if applicable.

Class com.amazonaws.services.ec2.model.VgwTelemetry

class VgwTelemetry extends Object implements Serializable

Serialized Fields

acceptedRouteCount

Integer acceptedRouteCount

The number of accepted routes.

lastStatusChange

Date lastStatusChange

The date and time of the last change in status.

outsideIpAddress

String outsideIpAddress

The Internet-routable IP address of the virtual private gateway's outside interface.

status

String status

The status of the VPN tunnel.

statusMessage

String statusMessage

If an error occurs, a description of the error.

Class com.amazonaws.services.ec2.model.Volume

class Volume extends Object implements Serializable

Serialized Fields

attachments

com.amazonaws.internal.SdkInternalList<VolumeAttachment> attachments

Information about the volume attachments.

availabilityZone

String availabilityZone

The Availability Zone for the volume.

createTime

Date createTime

The time stamp when volume creation was initiated.

encrypted

Boolean encrypted

Indicates whether the volume will be encrypted.

iops

Integer iops

The number of I/O operations per second (IOPS) that the volume supports. For Provisioned IOPS SSD volumes, this represents the number of IOPS that are provisioned for the volume. For General Purpose SSD volumes, 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.

kmsKeyId

String kmsKeyId

The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

size

Integer size

The size of the volume, in GiBs.

snapshotId

String snapshotId

The snapshot from which the volume was created, if applicable.

state

String state

The volume state.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the volume.

volumeId

String volumeId

The ID of the volume.

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.

Class com.amazonaws.services.ec2.model.VolumeAttachment

class VolumeAttachment extends Object implements Serializable

Serialized Fields

attachTime

Date attachTime

The time stamp when the attachment initiated.

deleteOnTermination

Boolean deleteOnTermination

Indicates whether the EBS volume is deleted on instance termination.

device

String device

The device name.

instanceId

String instanceId

The ID of the instance.

state

String state

The attachment state of the volume.

volumeId

String volumeId

The ID of the volume.

Class com.amazonaws.services.ec2.model.VolumeDetail

class VolumeDetail extends Object implements Serializable

Serialized Fields

size

Long size

The size of the volume, in GiB.

Class com.amazonaws.services.ec2.model.VolumeStatusAction

class VolumeStatusAction extends Object implements Serializable

Serialized Fields

code

String code

The code identifying the operation, for example, enable-volume-io.

description

String description

A description of the operation.

eventId

String eventId

The ID of the event associated with this operation.

eventType

String eventType

The event type associated with this operation.

Class com.amazonaws.services.ec2.model.VolumeStatusDetails

class VolumeStatusDetails extends Object implements Serializable

Serialized Fields

name

String name

The name of the volume status.

status

String status

The intended status of the volume status.

Class com.amazonaws.services.ec2.model.VolumeStatusEvent

class VolumeStatusEvent extends Object implements Serializable

Serialized Fields

description

String description

A description of the event.

eventId

String eventId

The ID of this event.

eventType

String eventType

The type of this event.

notAfter

Date notAfter

The latest end time of the event.

notBefore

Date notBefore

The earliest start time of the event.

Class com.amazonaws.services.ec2.model.VolumeStatusInfo

class VolumeStatusInfo extends Object implements Serializable

Serialized Fields

details

com.amazonaws.internal.SdkInternalList<VolumeStatusDetails> details

The details of the volume status.

status

String status

The status of the volume.

Class com.amazonaws.services.ec2.model.VolumeStatusItem

class VolumeStatusItem extends Object implements Serializable

Serialized Fields

actions

com.amazonaws.internal.SdkInternalList<VolumeStatusAction> actions

The details of the operation.

availabilityZone

String availabilityZone

The Availability Zone of the volume.

events

com.amazonaws.internal.SdkInternalList<VolumeStatusEvent> events

A list of events associated with the volume.

volumeId

String volumeId

The volume ID.

volumeStatus

VolumeStatusInfo volumeStatus

The volume status.

Class com.amazonaws.services.ec2.model.Vpc

class Vpc extends Object implements Serializable

Serialized Fields

cidrBlock

String cidrBlock

The CIDR block for the VPC.

dhcpOptionsId

String dhcpOptionsId

The ID of the set of DHCP options you've associated with the VPC (or default if the default options are associated with the VPC).

instanceTenancy

String instanceTenancy

The allowed tenancy of instances launched into the VPC.

isDefault

Boolean isDefault

Indicates whether the VPC is the default VPC.

state

String state

The current state of the VPC.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the VPC.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpcAttachment

class VpcAttachment extends Object implements Serializable

Serialized Fields

state

String state

The current state of the attachment.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpcClassicLink

class VpcClassicLink extends Object implements Serializable

Serialized Fields

classicLinkEnabled

Boolean classicLinkEnabled

Indicates whether the VPC is enabled for ClassicLink.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the VPC.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpcEndpoint

class VpcEndpoint extends Object implements Serializable

Serialized Fields

creationTimestamp

Date creationTimestamp

The date and time the VPC endpoint was created.

policyDocument

String policyDocument

The policy document associated with the endpoint.

routeTableIds

com.amazonaws.internal.SdkInternalList<String> routeTableIds

One or more route tables associated with the endpoint.

serviceName

String serviceName

The name of the AWS service to which the endpoint is associated.

state

String state

The state of the VPC endpoint.

vpcEndpointId

String vpcEndpointId

The ID of the VPC endpoint.

vpcId

String vpcId

The ID of the VPC to which the endpoint is associated.

Class com.amazonaws.services.ec2.model.VpcPeeringConnection

class VpcPeeringConnection extends Object implements Serializable

Serialized Fields

accepterVpcInfo

VpcPeeringConnectionVpcInfo accepterVpcInfo

Information about the accepter VPC. CIDR block information is not returned when creating a VPC peering connection, or when describing a VPC peering connection that's in the initiating-request or pending-acceptance state.

expirationTime

Date expirationTime

The time that an unaccepted VPC peering connection will expire.

requesterVpcInfo

VpcPeeringConnectionVpcInfo requesterVpcInfo

Information about the requester VPC.

status

VpcPeeringConnectionStateReason status

The status of the VPC peering connection.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the resource.

vpcPeeringConnectionId

String vpcPeeringConnectionId

The ID of the VPC peering connection.

Class com.amazonaws.services.ec2.model.VpcPeeringConnectionOptionsDescription

class VpcPeeringConnectionOptionsDescription extends Object implements Serializable

Serialized Fields

allowEgressFromLocalClassicLinkToRemoteVpc

Boolean allowEgressFromLocalClassicLinkToRemoteVpc

Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.

allowEgressFromLocalVpcToRemoteClassicLink

Boolean allowEgressFromLocalVpcToRemoteClassicLink

Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.

Class com.amazonaws.services.ec2.model.VpcPeeringConnectionStateReason

class VpcPeeringConnectionStateReason extends Object implements Serializable

Serialized Fields

code

String code

The status of the VPC peering connection.

message

String message

A message that provides more information about the status, if applicable.

Class com.amazonaws.services.ec2.model.VpcPeeringConnectionVpcInfo

class VpcPeeringConnectionVpcInfo extends Object implements Serializable

Serialized Fields

cidrBlock

String cidrBlock

The CIDR block for the VPC.

ownerId

String ownerId

The AWS account ID of the VPC owner.

peeringOptions

VpcPeeringConnectionOptionsDescription peeringOptions

Information about the VPC peering connection options for the accepter or requester VPC.

vpcId

String vpcId

The ID of the VPC.

Class com.amazonaws.services.ec2.model.VpnConnection

class VpnConnection extends Object implements Serializable

Serialized Fields

customerGatewayConfiguration

String customerGatewayConfiguration

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

customerGatewayId

String customerGatewayId

The ID of the customer gateway at your end of the VPN connection.

options

VpnConnectionOptions options

The VPN connection options.

routes

com.amazonaws.internal.SdkInternalList<VpnStaticRoute> routes

The static routes associated with the VPN connection.

state

String state

The current state of the VPN connection.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the VPN connection.

type

String type

The type of VPN connection.

vgwTelemetry

com.amazonaws.internal.SdkInternalList<VgwTelemetry> vgwTelemetry

Information about the VPN tunnel.

vpnConnectionId

String vpnConnectionId

The ID of the VPN connection.

vpnGatewayId

String vpnGatewayId

The ID of the virtual private gateway at the AWS side of the VPN connection.

Class com.amazonaws.services.ec2.model.VpnConnectionOptions

class VpnConnectionOptions extends Object implements Serializable

Serialized Fields

staticRoutesOnly

Boolean staticRoutesOnly

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

Class com.amazonaws.services.ec2.model.VpnConnectionOptionsSpecification

class VpnConnectionOptionsSpecification extends Object implements Serializable

Serialized Fields

staticRoutesOnly

Boolean staticRoutesOnly

Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.

Class com.amazonaws.services.ec2.model.VpnGateway

class VpnGateway extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.

state

String state

The current state of the virtual private gateway.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Any tags assigned to the virtual private gateway.

type

String type

The type of VPN connection the virtual private gateway supports.

vpcAttachments

com.amazonaws.internal.SdkInternalList<VpcAttachment> vpcAttachments

Any VPCs attached to the virtual private gateway.

vpnGatewayId

String vpnGatewayId

The ID of the virtual private gateway.

Class com.amazonaws.services.ec2.model.VpnStaticRoute

class VpnStaticRoute extends Object implements Serializable

Serialized Fields

destinationCidrBlock

String destinationCidrBlock

The CIDR block associated with the local subnet of the customer data center.

source

String source

Indicates how the routes were provided.

state

String state

The current state of the static route.

Package com.amazonaws.services.ecr.model

Class com.amazonaws.services.ecr.model.AuthorizationData

class 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

class BatchCheckLayerAvailabilityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerDigests

List<String> layerDigests

The digests of the image layers to check.

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.

Class com.amazonaws.services.ecr.model.BatchCheckLayerAvailabilityResult

class BatchCheckLayerAvailabilityResult extends Object implements Serializable

Serialized Fields

failures

List<LayerFailure> failures

Any failures associated with the call.

layers

List<Layer> layers

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

Class com.amazonaws.services.ecr.model.BatchDeleteImageRequest

class BatchDeleteImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageIds

List<ImageIdentifier> 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.

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.

Class com.amazonaws.services.ecr.model.BatchDeleteImageResult

class BatchDeleteImageResult extends Object implements Serializable

Serialized Fields

failures

List<ImageFailure> failures

Any failures associated with the call.

imageIds

List<ImageIdentifier> imageIds

The image IDs of the deleted images.

Class com.amazonaws.services.ecr.model.BatchGetImageRequest

class BatchGetImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageIds

List<ImageIdentifier> 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.

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.

Class com.amazonaws.services.ecr.model.BatchGetImageResult

class BatchGetImageResult extends Object implements Serializable

Serialized Fields

failures

List<ImageFailure> failures

Any failures associated with the call.

images

List<Image> images

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

Class com.amazonaws.services.ecr.model.CompleteLayerUploadRequest

class CompleteLayerUploadRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerDigests

List<String> layerDigests

The sha256 digest of the image layer.

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.

Class com.amazonaws.services.ecr.model.CompleteLayerUploadResult

class CompleteLayerUploadResult extends Object implements Serializable

Serialized Fields

layerDigest

String layerDigest

The sha256 digest of the image layer.

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.

Class com.amazonaws.services.ecr.model.CreateRepositoryRequest

class 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

class CreateRepositoryResult extends Object implements Serializable

Serialized Fields

repository

Repository repository

Class com.amazonaws.services.ecr.model.DeleteRepositoryPolicyRequest

class 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

class DeleteRepositoryPolicyResult extends Object implements Serializable

Serialized Fields

policyText

String policyText

The JSON repository policy that was deleted from the repository.

registryId

String registryId

The registry ID associated with the request.

repositoryName

String repositoryName

The repository name associated with the request.

Class com.amazonaws.services.ecr.model.DeleteRepositoryRequest

class DeleteRepositoryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

force

Boolean force

Force the deletion of the repository if it contains images.

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.

Class com.amazonaws.services.ecr.model.DeleteRepositoryResult

class DeleteRepositoryResult extends Object implements Serializable

Serialized Fields

repository

Repository repository

Class com.amazonaws.services.ecr.model.DescribeRepositoriesRequest

class DescribeRepositoriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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<String> repositoryNames

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

Class com.amazonaws.services.ecr.model.DescribeRepositoriesResult

class DescribeRepositoriesResult extends Object implements Serializable

Serialized Fields

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.

repositories

List<Repository> repositories

A list of repository objects corresponding to valid repositories.

Exception Class com.amazonaws.services.ecr.model.EmptyUploadException

class EmptyUploadException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecr.model.GetAuthorizationTokenRequest

class GetAuthorizationTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

registryIds

List<String> 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

class GetAuthorizationTokenResult extends Object implements Serializable

Serialized Fields

authorizationData

List<AuthorizationData> authorizationData

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

Class com.amazonaws.services.ecr.model.GetDownloadUrlForLayerRequest

class GetDownloadUrlForLayerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerDigest

String layerDigest

The digest of the image layer to download.

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.

Class com.amazonaws.services.ecr.model.GetDownloadUrlForLayerResult

class 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

class 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

class GetRepositoryPolicyResult extends Object implements Serializable

Serialized Fields

policyText

String policyText

The JSON repository policy text associated with the repository.

registryId

String registryId

The registry ID associated with the request.

repositoryName

String repositoryName

The repository name associated with the request.

Class com.amazonaws.services.ecr.model.Image

class Image extends Object implements Serializable

Serialized Fields

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.

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.

Exception Class com.amazonaws.services.ecr.model.ImageAlreadyExistsException

class ImageAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecr.model.ImageFailure

class ImageFailure extends Object implements Serializable

Serialized Fields

failureCode

String failureCode

The code associated with the failure.

failureReason

String failureReason

The reason for the failure.

imageId

ImageIdentifier imageId

The image ID associated with the failure.

Class com.amazonaws.services.ecr.model.ImageIdentifier

class 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

class 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

class InitiateLayerUploadResult extends Object implements Serializable

Serialized Fields

partSize

Long partSize

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

uploadId

String uploadId

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

Exception Class com.amazonaws.services.ecr.model.InvalidLayerException

class InvalidLayerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.InvalidLayerPartException

class InvalidLayerPartException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

lastValidByteReceived

Long lastValidByteReceived

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

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.

Exception Class com.amazonaws.services.ecr.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecr.model.Layer

class Layer extends Object implements Serializable

Serialized Fields

layerAvailability

String layerAvailability

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

layerDigest

String layerDigest

The sha256 digest of the image layer.

layerSize

Long layerSize

The size, in bytes, of the image layer.

Exception Class com.amazonaws.services.ecr.model.LayerAlreadyExistsException

class LayerAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecr.model.LayerFailure

class LayerFailure extends Object implements Serializable

Serialized Fields

failureCode

String failureCode

The failure code associated with the failure.

failureReason

String failureReason

The reason for the failure.

layerDigest

String layerDigest

The layer digest associated with the failure.

Exception Class com.amazonaws.services.ecr.model.LayerInaccessibleException

class LayerInaccessibleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.LayerPartTooSmallException

class LayerPartTooSmallException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.LayersNotFoundException

class LayersNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecr.model.ListImagesRequest

class ListImagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

Class com.amazonaws.services.ecr.model.ListImagesResult

class ListImagesResult extends Object implements Serializable

Serialized Fields

imageIds

List<ImageIdentifier> 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

class PutImageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

imageManifest

String imageManifest

The image manifest corresponding to the image to be uploaded.

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.

Class com.amazonaws.services.ecr.model.PutImageResult

class PutImageResult extends Object implements Serializable

Serialized Fields

image

Image image

Details of the image uploaded.

Class com.amazonaws.services.ecr.model.Repository

class Repository extends Object implements Serializable

Serialized Fields

registryId

String registryId

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

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.

repositoryName

String repositoryName

The name of the repository.

repositoryUri

String repositoryUri

The URI for the repository. You can use this URI for Docker push and pull operations.

Exception Class com.amazonaws.services.ecr.model.RepositoryAlreadyExistsException

class RepositoryAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.RepositoryNotEmptyException

class RepositoryNotEmptyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.RepositoryNotFoundException

class RepositoryNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.RepositoryPolicyNotFoundException

class RepositoryPolicyNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecr.model.ServerException

class ServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecr.model.SetRepositoryPolicyRequest

class SetRepositoryPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

policyText

String policyText

The JSON repository policy text to apply to the repository.

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.

Class com.amazonaws.services.ecr.model.SetRepositoryPolicyResult

class SetRepositoryPolicyResult extends Object implements Serializable

Serialized Fields

policyText

String policyText

The JSON repository policy text applied to the repository.

registryId

String registryId

The registry ID associated with the request.

repositoryName

String repositoryName

The repository name associated with the request.

Class com.amazonaws.services.ecr.model.UploadLayerPartRequest

class UploadLayerPartRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerPartBlob

ByteBuffer layerPartBlob

The base64-encoded layer part payload.

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.

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.

Class com.amazonaws.services.ecr.model.UploadLayerPartResult

class UploadLayerPartResult extends Object implements Serializable

Serialized Fields

lastByteReceived

Long lastByteReceived

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

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.

Exception Class com.amazonaws.services.ecr.model.UploadNotFoundException

class UploadNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.ecs.model

Class com.amazonaws.services.ecs.model.Attribute

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

Exception Class com.amazonaws.services.ecs.model.ClientException

class ClientException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.Cluster

class Cluster extends Object implements Serializable

Serialized Fields

activeServicesCount

Integer activeServicesCount

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

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.

pendingTasksCount

Integer pendingTasksCount

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

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.

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.

Exception Class com.amazonaws.services.ecs.model.ClusterContainsContainerInstancesException

class ClusterContainsContainerInstancesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecs.model.ClusterContainsServicesException

class ClusterContainsServicesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecs.model.ClusterNotFoundException

class ClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.Container

class Container extends Object implements Serializable

Serialized Fields

containerArn

String containerArn

The Amazon Resource Name (ARN) of the container.

exitCode

Integer exitCode

The exit code returned from the container.

lastStatus

String lastStatus

The last known status of the container.

name

String name

The name of the container.

networkBindings

com.amazonaws.internal.SdkInternalList<NetworkBinding> networkBindings

The network bindings associated with the container.

reason

String reason

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

taskArn

String taskArn

The Amazon Resource Name (ARN) of the task.

Class com.amazonaws.services.ecs.model.ContainerDefinition

class ContainerDefinition extends Object implements Serializable

Serialized Fields

command

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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.

dnsSearchDomains

com.amazonaws.internal.SdkInternalList<String> 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.

dnsServers

com.amazonaws.internal.SdkInternalList<String> 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.

dockerLabels

Map<String,String> 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"

dockerSecurityOptions

com.amazonaws.internal.SdkInternalList<String> 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.

entryPoint

com.amazonaws.internal.SdkInternalList<String> 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.

environment

com.amazonaws.internal.SdkInternalList<KeyValuePair> 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.

essential

Boolean essential

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. 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. If you have an application that is composed of multiple containers, you should group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon EC2 Container Service Developer Guide.

extraHosts

com.amazonaws.internal.SdkInternalList<HostEntry> 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.

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.

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

links

com.amazonaws.internal.SdkInternalList<String> 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.

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. By default, containers use the same logging driver that the Docker daemon uses; however the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Currently unsupported log drivers may be available in future releases of the Amazon ECS container agent.

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.

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.

mountPoints

com.amazonaws.internal.SdkInternalList<MountPoint> 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.

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.

portMappings

com.amazonaws.internal.SdkInternalList<PortMapping> 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.

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.

ulimits

com.amazonaws.internal.SdkInternalList<Ulimit> 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"

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.

volumesFrom

com.amazonaws.internal.SdkInternalList<VolumeFrom> 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.

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.

Class com.amazonaws.services.ecs.model.ContainerInstance

class ContainerInstance extends Object implements Serializable

Serialized Fields

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.

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<Attribute> attributes

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

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.

pendingTasksCount

Integer pendingTasksCount

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

registeredResources

com.amazonaws.internal.SdkInternalList<Resource> registeredResources

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

remainingResources

com.amazonaws.internal.SdkInternalList<Resource> remainingResources

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

runningTasksCount

Integer runningTasksCount

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

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.

versionInfo

VersionInfo versionInfo

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

Class com.amazonaws.services.ecs.model.ContainerOverride

class ContainerOverride extends Object implements Serializable

Serialized Fields

command

com.amazonaws.internal.SdkInternalList<String> 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<KeyValuePair> 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.

name

String name

The name of the container that receives the override.

Class com.amazonaws.services.ecs.model.CreateClusterRequest

class 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

class CreateClusterResult extends Object implements Serializable

Serialized Fields

cluster

Cluster cluster

The full description of your new cluster.

Class com.amazonaws.services.ecs.model.CreateServiceRequest

class CreateServiceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientToken

String clientToken

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

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.

deploymentConfiguration

DeploymentConfiguration deploymentConfiguration

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

desiredCount

Integer desiredCount

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

loadBalancers

com.amazonaws.internal.SdkInternalList<LoadBalancer> 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.

role

String role

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

If your specified role has a path other than /, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.

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.

Class com.amazonaws.services.ecs.model.CreateServiceResult

class 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

class 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

class DeleteClusterResult extends Object implements Serializable

Serialized Fields

cluster

Cluster cluster

The full description of the deleted cluster.

Class com.amazonaws.services.ecs.model.DeleteServiceRequest

class 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

class DeleteServiceResult extends Object implements Serializable

Serialized Fields

service

Service service

The full description of the deleted service.

Class com.amazonaws.services.ecs.model.Deployment

class Deployment extends Object implements Serializable

Serialized Fields

createdAt

Date createdAt

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

desiredCount

Integer desiredCount

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

id

String id

The ID of the deployment.

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.

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.

updatedAt

Date updatedAt

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

Class com.amazonaws.services.ecs.model.DeploymentConfiguration

class 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

class 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

class DeregisterContainerInstanceResult extends Object implements Serializable

Serialized Fields

containerInstance

ContainerInstance containerInstance

Class com.amazonaws.services.ecs.model.DeregisterTaskDefinitionRequest

class 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

class DeregisterTaskDefinitionResult extends Object implements Serializable

Serialized Fields

taskDefinition

TaskDefinition taskDefinition

The full description of the deregistered task.

Class com.amazonaws.services.ecs.model.DescribeClustersRequest

class DescribeClustersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusters

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeClustersResult extends Object implements Serializable

Serialized Fields

clusters

com.amazonaws.internal.SdkInternalList<Cluster> clusters

The list of clusters.

failures

com.amazonaws.internal.SdkInternalList<Failure> failures

Any failures associated with the call.

Class com.amazonaws.services.ecs.model.DescribeContainerInstancesRequest

class 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<String> containerInstances

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

Class com.amazonaws.services.ecs.model.DescribeContainerInstancesResult

class DescribeContainerInstancesResult extends Object implements Serializable

Serialized Fields

containerInstances

com.amazonaws.internal.SdkInternalList<ContainerInstance> containerInstances

The list of container instances.

failures

com.amazonaws.internal.SdkInternalList<Failure> failures

Any failures associated with the call.

Class com.amazonaws.services.ecs.model.DescribeServicesRequest

class 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<String> services

A list of services to describe.

Class com.amazonaws.services.ecs.model.DescribeServicesResult

class DescribeServicesResult extends Object implements Serializable

Serialized Fields

failures

com.amazonaws.internal.SdkInternalList<Failure> failures

Any failures associated with the call.

services

com.amazonaws.internal.SdkInternalList<Service> services

The list of services described.

Class com.amazonaws.services.ecs.model.DescribeTaskDefinitionRequest

class 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

class DescribeTaskDefinitionResult extends Object implements Serializable

Serialized Fields

taskDefinition

TaskDefinition taskDefinition

The full task definition description.

Class com.amazonaws.services.ecs.model.DescribeTasksRequest

class 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<String> tasks

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

Class com.amazonaws.services.ecs.model.DescribeTasksResult

class DescribeTasksResult extends Object implements Serializable

Serialized Fields

failures

com.amazonaws.internal.SdkInternalList<Failure> failures

Any failures associated with the call.

tasks

com.amazonaws.internal.SdkInternalList<Task> tasks

The list of tasks.

Class com.amazonaws.services.ecs.model.DiscoverPollEndpointRequest

class DiscoverPollEndpointRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cluster

String cluster

The cluster that the container instance belongs to.

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 .

Class com.amazonaws.services.ecs.model.DiscoverPollEndpointResult

class 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

class 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

class 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

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

Exception Class com.amazonaws.services.ecs.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.KeyValuePair

class 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

class ListClustersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Class com.amazonaws.services.ecs.model.ListClustersResult

class ListClustersResult extends Object implements Serializable

Serialized Fields

clusterArns

com.amazonaws.internal.SdkInternalList<String> 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

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

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.

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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Class com.amazonaws.services.ecs.model.ListContainerInstancesResult

class ListContainerInstancesResult extends Object implements Serializable

Serialized Fields

containerInstanceArns

com.amazonaws.internal.SdkInternalList<String> 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

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

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.

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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

Class com.amazonaws.services.ecs.model.ListServicesResult

class ListServicesResult extends Object implements Serializable

Serialized Fields

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.

serviceArns

com.amazonaws.internal.SdkInternalList<String> serviceArns

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

Class com.amazonaws.services.ecs.model.ListTaskDefinitionFamiliesRequest

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

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.

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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

status

String status

The task definition family status with which to filter the ListTaskDefinitionFamilies results. By default, both ACTIVE and INACTIVE task definition families are listed. If this parameter is set to ACTIVE, only task definition families that have an ACTIVE task definition revision are returned. If this parameter is set to INACTIVE, only task definition families that do not have any ACTIVE task definition revisions are returned. If you paginate the resulting output, be sure to keep the status value constant in each subsequent request.

Class com.amazonaws.services.ecs.model.ListTaskDefinitionFamiliesResult

class ListTaskDefinitionFamiliesResult extends Object implements Serializable

Serialized Fields

families

com.amazonaws.internal.SdkInternalList<String> 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

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

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.

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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

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.

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.

Class com.amazonaws.services.ecs.model.ListTaskDefinitionsResult

class ListTaskDefinitionsResult extends Object implements Serializable

Serialized Fields

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.

taskDefinitionArns

com.amazonaws.internal.SdkInternalList<String> taskDefinitionArns

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

Class com.amazonaws.services.ecs.model.ListTasksRequest

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

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.

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.

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.

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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

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.

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.

Class com.amazonaws.services.ecs.model.ListTasksResult

class ListTasksResult extends Object implements Serializable

Serialized Fields

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.

taskArns

com.amazonaws.internal.SdkInternalList<String> taskArns

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

Class com.amazonaws.services.ecs.model.LoadBalancer

class LoadBalancer extends Object implements Serializable

Serialized Fields

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.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.ecs.model.LogConfiguration

class LogConfiguration extends Object implements Serializable

Serialized Fields

logDriver

String logDriver

The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

If you have a custom driver that is not listed above that you would like to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that is available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, Amazon Web Services does not currently provide support for running modified copies of this software.

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<String,String> 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"

Exception Class com.amazonaws.services.ecs.model.MissingVersionException

class MissingVersionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.MountPoint

class MountPoint extends Object implements Serializable

Serialized Fields

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.

sourceVolume

String sourceVolume

The name of the volume to mount.

Class com.amazonaws.services.ecs.model.NetworkBinding

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

Exception Class com.amazonaws.services.ecs.model.NoUpdateAvailableException

class NoUpdateAvailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.PortMapping

class 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). Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.

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 100 reserved ports at a time, including the default reserved ports (automatically assigned ports do not count toward the 100 reserved ports 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

class RegisterContainerInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.SdkInternalList<Attribute> attributes

The container instance attributes that this container instance supports.

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

containerInstanceArn

String containerInstanceArn

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

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

Class com.amazonaws.services.ecs.model.RegisterContainerInstanceResult

class RegisterContainerInstanceResult extends Object implements Serializable

Serialized Fields

containerInstance

ContainerInstance containerInstance

Class com.amazonaws.services.ecs.model.RegisterTaskDefinitionRequest

class RegisterTaskDefinitionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

containerDefinitions

com.amazonaws.internal.SdkInternalList<ContainerDefinition> containerDefinitions

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

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.

volumes

com.amazonaws.internal.SdkInternalList<Volume> volumes

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

Class com.amazonaws.services.ecs.model.RegisterTaskDefinitionResult

class 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

class Resource extends Object implements Serializable

Serialized Fields

doubleValue

Double doubleValue

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

integerValue

Integer integerValue

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

longValue

Long longValue

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

name

String name

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

stringSetValue

com.amazonaws.internal.SdkInternalList<String> stringSetValue

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

type

String type

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

Class com.amazonaws.services.ecs.model.RunTaskRequest

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

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.

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.

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. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

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.

Class com.amazonaws.services.ecs.model.RunTaskResult

class RunTaskResult extends Object implements Serializable

Serialized Fields

failures

com.amazonaws.internal.SdkInternalList<Failure> failures

Any failures associated with the call.

tasks

com.amazonaws.internal.SdkInternalList<Task> tasks

A full description of the tasks that were run. Each task that was successfully placed on your cluster are described here.

Exception Class com.amazonaws.services.ecs.model.ServerException

class ServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.Service

class Service extends Object implements Serializable

Serialized Fields

clusterArn

String clusterArn

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

createdAt

Date createdAt

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

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<Deployment> deployments

The current state of deployments for the service.

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.

events

com.amazonaws.internal.SdkInternalList<ServiceEvent> events

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

loadBalancers

com.amazonaws.internal.SdkInternalList<LoadBalancer> 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.

pendingCount

Integer pendingCount

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

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.

runningCount

Integer runningCount

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

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.

status

String status

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

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.

Class com.amazonaws.services.ecs.model.ServiceEvent

class ServiceEvent extends Object implements Serializable

Serialized Fields

createdAt

Date createdAt

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

id

String id

The ID string of the event.

message

String message

The event message.

Exception Class com.amazonaws.services.ecs.model.ServiceNotActiveException

class ServiceNotActiveException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.ecs.model.ServiceNotFoundException

class ServiceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.StartTaskRequest

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

containerInstances

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the startedBy parameter contains the deployment ID of the service that starts it.

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.

Class com.amazonaws.services.ecs.model.StartTaskResult

class StartTaskResult extends Object implements Serializable

Serialized Fields

failures

com.amazonaws.internal.SdkInternalList<Failure> failures

Any failures associated with the call.

tasks

com.amazonaws.internal.SdkInternalList<Task> tasks

A full description of the tasks that were started. Each task that was successfully placed on your container instances are described here.

Class com.amazonaws.services.ecs.model.StopTaskRequest

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

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.

task

String task

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

Class com.amazonaws.services.ecs.model.StopTaskResult

class StopTaskResult extends Object implements Serializable

Serialized Fields

task

Task task

Class com.amazonaws.services.ecs.model.SubmitContainerStateChangeRequest

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

containerName

String containerName

The name of the container.

exitCode

Integer exitCode

The exit code returned for the state change request.

networkBindings

com.amazonaws.internal.SdkInternalList<NetworkBinding> networkBindings

The network bindings of the container.

reason

String reason

The reason for the state change request.

status

String status

The status of the state change request.

task

String task

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

Class com.amazonaws.services.ecs.model.SubmitContainerStateChangeResult

class SubmitContainerStateChangeResult extends Object implements Serializable

Serialized Fields

acknowledgment

String acknowledgment

Acknowledgement of the state change.

Class com.amazonaws.services.ecs.model.SubmitTaskStateChangeRequest

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

reason

String reason

The reason for the state change request.

status

String status

The status of the state change request.

task

String task

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

Class com.amazonaws.services.ecs.model.SubmitTaskStateChangeResult

class SubmitTaskStateChangeResult extends Object implements Serializable

Serialized Fields

acknowledgment

String acknowledgment

Acknowledgement of the state change.

Class com.amazonaws.services.ecs.model.Task

class Task extends Object implements Serializable

Serialized Fields

clusterArn

String clusterArn

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

containerInstanceArn

String containerInstanceArn

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

containers

com.amazonaws.internal.SdkInternalList<Container> containers

The containers associated with the task.

createdAt

Date createdAt

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

desiredStatus

String desiredStatus

The desired status of the task.

lastStatus

String lastStatus

The last known status of the task.

overrides

TaskOverride overrides

One or more container overrides.

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

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.

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

stoppedReason

String stoppedReason

The reason the task was stopped.

taskArn

String taskArn

The Amazon Resource Name (ARN) of the task.

taskDefinitionArn

String taskDefinitionArn

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

Class com.amazonaws.services.ecs.model.TaskDefinition

class TaskDefinition extends Object implements Serializable

Serialized Fields

containerDefinitions

com.amazonaws.internal.SdkInternalList<ContainerDefinition> 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.

requiresAttributes

com.amazonaws.internal.SdkInternalList<Attribute> requiresAttributes

The container instance attributes required by your task.

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

status

String status

The status of the task definition.

taskDefinitionArn

String taskDefinitionArn

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

volumes

com.amazonaws.internal.SdkInternalList<Volume> 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.

Class com.amazonaws.services.ecs.model.TaskOverride

class TaskOverride extends Object implements Serializable

Serialized Fields

containerOverrides

com.amazonaws.internal.SdkInternalList<ContainerOverride> containerOverrides

One or more container overrides sent to a task.

Class com.amazonaws.services.ecs.model.Ulimit

class Ulimit extends Object implements Serializable

Serialized Fields

hardLimit

Integer hardLimit

The hard limit for the ulimit type.

name

String name

The type of the ulimit.

softLimit

Integer softLimit

The soft limit for the ulimit type.

Class com.amazonaws.services.ecs.model.UpdateContainerAgentRequest

class 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

class UpdateContainerAgentResult extends Object implements Serializable

Serialized Fields

containerInstance

ContainerInstance containerInstance

Exception Class com.amazonaws.services.ecs.model.UpdateInProgressException

class UpdateInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.ecs.model.UpdateServiceRequest

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

deploymentConfiguration

DeploymentConfiguration deploymentConfiguration

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

desiredCount

Integer desiredCount

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

service

String service

The name of the service to update.

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.

Class com.amazonaws.services.ecs.model.UpdateServiceResult

class 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

class VersionInfo extends Object implements Serializable

Serialized Fields

agentHash

String agentHash

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

agentVersion

String agentVersion

The version number of the Amazon ECS container agent.

dockerVersion

String dockerVersion

The Docker version running on the container instance.

Class com.amazonaws.services.ecs.model.Volume

class Volume extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.ecs.model.VolumeFrom

class VolumeFrom extends Object implements Serializable

Serialized Fields

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.

sourceContainer

String sourceContainer

The name of the container to mount volumes from.

Package com.amazonaws.services.elasticache.model

Class com.amazonaws.services.elasticache.model.AddTagsToResourceRequest

class 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.SdkInternalList<Tag> 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

class AddTagsToResourceResult extends Object implements Serializable

Serialized Fields

tagList

com.amazonaws.internal.SdkInternalList<Tag> tagList

A list of cost allocation tags as key-value pairs.

Exception Class com.amazonaws.services.elasticache.model.AuthorizationAlreadyExistsException

class AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.AuthorizationNotFoundException

class AuthorizationNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.AuthorizeCacheSecurityGroupIngressRequest

class 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

class AvailabilityZone extends Object implements Serializable

Serialized Fields

name

String name

The name of the Availability Zone.

Class com.amazonaws.services.elasticache.model.CacheCluster

class CacheCluster extends Object implements Serializable

Serialized Fields

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

This parameter is currently disabled.

cacheClusterCreateTime

Date cacheClusterCreateTime

The date and time when the cache cluster was created.

cacheClusterId

String cacheClusterId

The user-supplied identifier of the cache cluster. This identifier is a unique key that identifies a 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.

cacheNodes

com.amazonaws.internal.SdkInternalList<CacheNode> cacheNodes

A list of cache nodes that are members of the cache cluster.

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.

cacheParameterGroup

CacheParameterGroupStatus cacheParameterGroup

cacheSecurityGroups

com.amazonaws.internal.SdkInternalList<CacheSecurityGroupMembership> cacheSecurityGroups

A list of cache security group elements, composed of name and status sub-elements.

cacheSubnetGroupName

String cacheSubnetGroupName

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

clientDownloadLandingPage

String clientDownloadLandingPage

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

configurationEndpoint

Endpoint configurationEndpoint

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.

notificationConfiguration

NotificationConfiguration notificationConfiguration

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.

pendingModifiedValues

PendingModifiedValues pendingModifiedValues

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.

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

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.

securityGroups

com.amazonaws.internal.SdkInternalList<SecurityGroupMembership> securityGroups

A list of VPC Security Groups associated with the cache cluster.

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

Exception Class com.amazonaws.services.elasticache.model.CacheClusterAlreadyExistsException

class CacheClusterAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheClusterNotFoundException

class CacheClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.CacheEngineVersion

class CacheEngineVersion extends Object implements Serializable

Serialized Fields

cacheEngineDescription

String cacheEngineDescription

The description of the cache engine.

cacheEngineVersionDescription

String cacheEngineVersionDescription

The description of the cache engine version.

cacheParameterGroupFamily

String cacheParameterGroupFamily

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

engine

String engine

The name of the cache engine.

engineVersion

String engineVersion

The version number of the cache engine.

Class com.amazonaws.services.elasticache.model.CacheNode

class CacheNode extends Object implements Serializable

Serialized Fields

cacheNodeCreateTime

Date cacheNodeCreateTime

The date and time when the cache node was created.

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.

customerAvailabilityZone

String customerAvailabilityZone

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

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.

Class com.amazonaws.services.elasticache.model.CacheNodeTypeSpecificParameter

class CacheNodeTypeSpecificParameter extends Object implements Serializable

Serialized Fields

allowedValues

String allowedValues

The valid range of values for the parameter.

cacheNodeTypeSpecificValues

com.amazonaws.internal.SdkInternalList<CacheNodeTypeSpecificValue> cacheNodeTypeSpecificValues

A list of cache node types and their corresponding values for this parameter.

dataType

String dataType

The valid data type for the parameter.

description

String description

A description of 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.

parameterName

String parameterName

The name of the parameter.

source

String source

The source of the parameter value.

Class com.amazonaws.services.elasticache.model.CacheNodeTypeSpecificValue

class 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

class CacheParameterGroup extends Object implements Serializable

Serialized Fields

cacheParameterGroupFamily

String cacheParameterGroupFamily

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

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group.

description

String description

The description for this cache parameter group.

Exception Class com.amazonaws.services.elasticache.model.CacheParameterGroupAlreadyExistsException

class CacheParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheParameterGroupNotFoundException

class CacheParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheParameterGroupQuotaExceededException

class CacheParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.CacheParameterGroupStatus

class CacheParameterGroupStatus extends Object implements Serializable

Serialized Fields

cacheNodeIdsToReboot

com.amazonaws.internal.SdkInternalList<String> 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.).

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group.

parameterApplyStatus

String parameterApplyStatus

The status of parameter updates.

Class com.amazonaws.services.elasticache.model.CacheSecurityGroup

class CacheSecurityGroup extends Object implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

The name of the cache security group.

description

String description

The description of the cache security group.

eC2SecurityGroups

com.amazonaws.internal.SdkInternalList<EC2SecurityGroup> eC2SecurityGroups

A list of Amazon EC2 security groups that are associated with this cache security group.

ownerId

String ownerId

The AWS account ID of the cache security group owner.

Exception Class com.amazonaws.services.elasticache.model.CacheSecurityGroupAlreadyExistsException

class CacheSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.CacheSecurityGroupMembership

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

Exception Class com.amazonaws.services.elasticache.model.CacheSecurityGroupNotFoundException

class CacheSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheSecurityGroupQuotaExceededException

class CacheSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.CacheSubnetGroup

class CacheSubnetGroup extends Object implements Serializable

Serialized Fields

cacheSubnetGroupDescription

String cacheSubnetGroupDescription

The description of the cache subnet group.

cacheSubnetGroupName

String cacheSubnetGroupName

The name of the cache subnet group.

subnets

com.amazonaws.internal.SdkInternalList<Subnet> subnets

A list of subnets associated with the cache subnet group.

vpcId

String vpcId

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

Exception Class com.amazonaws.services.elasticache.model.CacheSubnetGroupAlreadyExistsException

class CacheSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheSubnetGroupInUseException

class CacheSubnetGroupInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheSubnetGroupNotFoundException

class CacheSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheSubnetGroupQuotaExceededException

class CacheSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.CacheSubnetQuotaExceededException

class CacheSubnetQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.ClusterQuotaForCustomerExceededException

class ClusterQuotaForCustomerExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.CopySnapshotRequest

class 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

class CreateCacheClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

This parameter is currently disabled.

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.

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.

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.

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.

cacheSecurityGroupNames

com.amazonaws.internal.SdkInternalList<String> 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).

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

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.

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.

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

port

Integer port

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

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.SdkInternalList<String> 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:

Example: All three Memcached nodes in one Availability Zone:

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

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.

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> 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).

snapshotArns

com.amazonaws.internal.SdkInternalList<String> 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.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.CreateCacheParameterGroupRequest

class CreateCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

cacheParameterGroupName

String cacheParameterGroupName

A user-specified name for the cache parameter group.

description

String description

A user-specified description for the cache parameter group.

Class com.amazonaws.services.elasticache.model.CreateCacheSecurityGroupRequest

class 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

class CreateCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSubnetGroupDescription

String cacheSubnetGroupDescription

A description for the cache subnet group.

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

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

A list of VPC subnet IDs for the cache subnet group.

Class com.amazonaws.services.elasticache.model.CreateReplicationGroupRequest

class CreateReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

This parameter is currently disabled.

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.

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.

cacheSecurityGroupNames

com.amazonaws.internal.SdkInternalList<String> cacheSecurityGroupNames

A list of cache security group names to associate with this replication group.

cacheSubnetGroupName

String cacheSubnetGroupName

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

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.

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.

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.

port

Integer port

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

preferredCacheClusterAZs

com.amazonaws.internal.SdkInternalList<String> 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.

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

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.

replicationGroupDescription

String replicationGroupDescription

A user-created description for the replication group.

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.

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> 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).

snapshotArns

com.amazonaws.internal.SdkInternalList<String> 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.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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.CreateSnapshotRequest

class 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

class 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

class 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.DeleteCacheParameterGroupResult

class DeleteCacheParameterGroupResult extends Object implements Serializable

Class com.amazonaws.services.elasticache.model.DeleteCacheSecurityGroupRequest

class 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.DeleteCacheSecurityGroupResult

class DeleteCacheSecurityGroupResult extends Object implements Serializable

Class com.amazonaws.services.elasticache.model.DeleteCacheSubnetGroupRequest

class 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.DeleteCacheSubnetGroupResult

class DeleteCacheSubnetGroupResult extends Object implements Serializable

Class com.amazonaws.services.elasticache.model.DeleteReplicationGroupRequest

class DeleteReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.elasticache.model.DeleteSnapshotRequest

class 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

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

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: 100

Constraints: minimum 20; maximum 100.

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

class DescribeCacheClustersResult extends Object implements Serializable

Serialized Fields

cacheClusters

com.amazonaws.internal.SdkInternalList<CacheCluster> cacheClusters

A list of cache clusters. Each item in the list contains detailed information about one cache cluster.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

Class com.amazonaws.services.elasticache.model.DescribeCacheEngineVersionsRequest

class DescribeCacheEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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.

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

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: 100

Constraints: minimum 20; maximum 100.

Class com.amazonaws.services.elasticache.model.DescribeCacheEngineVersionsResult

class DescribeCacheEngineVersionsResult extends Object implements Serializable

Serialized Fields

cacheEngineVersions

com.amazonaws.internal.SdkInternalList<CacheEngineVersion> cacheEngineVersions

A list of cache engine version details. Each element in the list contains detailed information about one cache engine version.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

Class com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsRequest

class DescribeCacheParameterGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

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

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: 100

Constraints: minimum 20; maximum 100.

Class com.amazonaws.services.elasticache.model.DescribeCacheParameterGroupsResult

class DescribeCacheParameterGroupsResult extends Object implements Serializable

Serialized Fields

cacheParameterGroups

com.amazonaws.internal.SdkInternalList<CacheParameterGroup> cacheParameterGroups

A list of cache parameter groups. Each element in the list contains detailed information about one cache parameter group.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

Class com.amazonaws.services.elasticache.model.DescribeCacheParametersRequest

class DescribeCacheParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

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

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: 100

Constraints: minimum 20; maximum 100.

source

String source

The parameter types to return.

Valid values: user | system | engine-default

Class com.amazonaws.services.elasticache.model.DescribeCacheParametersResult

class DescribeCacheParametersResult extends Object implements Serializable

Serialized Fields

cacheNodeTypeSpecificParameters

com.amazonaws.internal.SdkInternalList<CacheNodeTypeSpecificParameter> cacheNodeTypeSpecificParameters

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of Parameter instances.

Class com.amazonaws.services.elasticache.model.DescribeCacheSecurityGroupsRequest

class DescribeCacheSecurityGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSecurityGroupName

String cacheSecurityGroupName

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

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: 100

Constraints: minimum 20; maximum 100.

Class com.amazonaws.services.elasticache.model.DescribeCacheSecurityGroupsResult

class DescribeCacheSecurityGroupsResult extends Object implements Serializable

Serialized Fields

cacheSecurityGroups

com.amazonaws.internal.SdkInternalList<CacheSecurityGroup> cacheSecurityGroups

A list of cache security groups. Each element in the list contains detailed information about one group.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

Class com.amazonaws.services.elasticache.model.DescribeCacheSubnetGroupsRequest

class DescribeCacheSubnetGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSubnetGroupName

String cacheSubnetGroupName

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

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: 100

Constraints: minimum 20; maximum 100.

Class com.amazonaws.services.elasticache.model.DescribeCacheSubnetGroupsResult

class DescribeCacheSubnetGroupsResult extends Object implements Serializable

Serialized Fields

cacheSubnetGroups

com.amazonaws.internal.SdkInternalList<CacheSubnetGroup> cacheSubnetGroups

A list of cache subnet groups. Each element in the list contains detailed information about one group.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

Class com.amazonaws.services.elasticache.model.DescribeEngineDefaultParametersRequest

class 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

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: 100

Constraints: minimum 20; maximum 100.

Class com.amazonaws.services.elasticache.model.DescribeEventsRequest

class DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

duration

Integer duration

The number of minutes' worth of events to retrieve.

endTime

Date endTime

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

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: 100

Constraints: minimum 20; maximum 100.

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

startTime

Date startTime

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

Class com.amazonaws.services.elasticache.model.DescribeEventsResult

class DescribeEventsResult extends Object implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalList<Event> events

A list of events. Each element in the list contains detailed information about one event.

marker

String marker

Provides an identifier to allow retrieval of paginated results.

Class com.amazonaws.services.elasticache.model.DescribeReplicationGroupsRequest

class DescribeReplicationGroupsRequest extends AmazonWebServiceRequest 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.

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.

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.

Class com.amazonaws.services.elasticache.model.DescribeReplicationGroupsResult

class DescribeReplicationGroupsResult extends Object implements Serializable

Serialized Fields

marker

String marker

Provides an identifier to allow retrieval of paginated results.

replicationGroups

com.amazonaws.internal.SdkInternalList<ReplicationGroup> 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

class DescribeReservedCacheNodesOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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: 100

Constraints: minimum 20; maximum 100.

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"

productDescription

String productDescription

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

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

Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesOfferingsResult

class DescribeReservedCacheNodesOfferingsResult extends Object implements Serializable

Serialized Fields

marker

String marker

Provides an identifier to allow retrieval of paginated results.

reservedCacheNodesOfferings

com.amazonaws.internal.SdkInternalList<ReservedCacheNodesOffering> 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

class DescribeReservedCacheNodesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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: 100

Constraints: minimum 20; maximum 100.

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"

productDescription

String productDescription

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

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.

Class com.amazonaws.services.elasticache.model.DescribeReservedCacheNodesResult

class DescribeReservedCacheNodesResult extends Object implements Serializable

Serialized Fields

marker

String marker

Provides an identifier to allow retrieval of paginated results.

reservedCacheNodes

com.amazonaws.internal.SdkInternalList<ReservedCacheNode> 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

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

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.

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.

Class com.amazonaws.services.elasticache.model.DescribeSnapshotsResult

class 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.SdkInternalList<Snapshot> snapshots

A list of snapshots. Each item in the list contains detailed information about one snapshot.

Class com.amazonaws.services.elasticache.model.EC2SecurityGroup

class EC2SecurityGroup extends Object implements Serializable

Serialized Fields

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.

status

String status

The status of the Amazon EC2 security group.

Class com.amazonaws.services.elasticache.model.Endpoint

class 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

class EngineDefaults extends Object implements Serializable

Serialized Fields

cacheNodeTypeSpecificParameters

com.amazonaws.internal.SdkInternalList<CacheNodeTypeSpecificParameter> cacheNodeTypeSpecificParameters

A list of parameters specific to a particular cache node type. Each element in the list contains detailed information about one parameter.

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.SdkInternalList<Parameter> parameters

Contains a list of engine default parameters.

Class com.amazonaws.services.elasticache.model.Event

class Event extends Object implements Serializable

Serialized Fields

dateValue

Date dateValue

The date and time when the event occurred.

message

String message

The text of the event.

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.

Exception Class com.amazonaws.services.elasticache.model.InsufficientCacheClusterCapacityException

class InsufficientCacheClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidARNException

class InvalidARNException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidCacheClusterStateException

class InvalidCacheClusterStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidCacheParameterGroupStateException

class InvalidCacheParameterGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidCacheSecurityGroupStateException

class InvalidCacheSecurityGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidParameterCombinationException

class InvalidParameterCombinationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidParameterValueException

class InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidReplicationGroupStateException

class InvalidReplicationGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidSnapshotStateException

class InvalidSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidSubnetException

class InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.InvalidVPCNetworkStateException

class InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.ListAllowedNodeTypeModificationsRequest

class 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

class ListAllowedNodeTypeModificationsResult extends Object implements Serializable

Serialized Fields

scaleUpModifications

com.amazonaws.internal.SdkInternalList<String> 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

class 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

class ListTagsForResourceResult extends Object implements Serializable

Serialized Fields

tagList

com.amazonaws.internal.SdkInternalList<Tag> tagList

A list of cost allocation tags as key-value pairs.

Class com.amazonaws.services.elasticache.model.ModifyCacheClusterRequest

class ModifyCacheClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

This parameter is currently disabled.

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.

cacheClusterId

String cacheClusterId

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

cacheNodeIdsToRemove

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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.

cacheSecurityGroupNames

com.amazonaws.internal.SdkInternalList<String> 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".

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.

newAvailabilityZones

com.amazonaws.internal.SdkInternalList<String> 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:

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.

notificationTopicStatus

String notificationTopicStatus

The status of the Amazon SNS notification topic. Notifications are sent only if the status is active.

Valid values: active | inactive

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.

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

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> 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).

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.

Class com.amazonaws.services.elasticache.model.ModifyCacheParameterGroupRequest

class ModifyCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group to modify.

parameterNameValues

com.amazonaws.internal.SdkInternalList<ParameterNameValue> 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

class ModifyCacheParameterGroupResult extends Object implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group.

Class com.amazonaws.services.elasticache.model.ModifyCacheSubnetGroupRequest

class ModifyCacheSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheSubnetGroupDescription

String cacheSubnetGroupDescription

A description for the cache subnet group.

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

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

The EC2 subnet IDs for the cache subnet group.

Class com.amazonaws.services.elasticache.model.ModifyReplicationGroupRequest

class ModifyReplicationGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

This parameter is currently disabled.

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.

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.

cacheSecurityGroupNames

com.amazonaws.internal.SdkInternalList<String> 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".

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.

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.

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

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

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.

replicationGroupDescription

String replicationGroupDescription

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

replicationGroupId

String replicationGroupId

The identifier of the replication group to modify.

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> 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).

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.

snapshottingClusterId

String snapshottingClusterId

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

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.

Class com.amazonaws.services.elasticache.model.NodeGroup

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

nodeGroupMembers

com.amazonaws.internal.SdkInternalList<NodeGroupMember> nodeGroupMembers

A list containing information about individual nodes within the node group.

primaryEndpoint

Endpoint primaryEndpoint

status

String status

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

Class com.amazonaws.services.elasticache.model.NodeGroupMember

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

currentRole

String currentRole

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

preferredAvailabilityZone

String preferredAvailabilityZone

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

readEndpoint

Endpoint readEndpoint

Exception Class com.amazonaws.services.elasticache.model.NodeQuotaForClusterExceededException

class NodeQuotaForClusterExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.NodeQuotaForCustomerExceededException

class NodeQuotaForCustomerExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.NodeSnapshot

class NodeSnapshot extends Object implements Serializable

Serialized Fields

cacheNodeCreateTime

Date cacheNodeCreateTime

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

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.

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

class 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

class Parameter extends Object implements Serializable

Serialized Fields

allowedValues

String allowedValues

The valid range of values for the parameter.

dataType

String dataType

The valid data type for the parameter.

description

String description

A description of 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.

parameterName

String parameterName

The name of the parameter.

parameterValue

String parameterValue

The value of the parameter.

source

String source

The source of the parameter.

Class com.amazonaws.services.elasticache.model.ParameterNameValue

class 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

class PendingModifiedValues extends Object implements Serializable

Serialized Fields

cacheNodeIdsToRemove

com.amazonaws.internal.SdkInternalList<String> 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.).

cacheNodeType

String cacheNodeType

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

engineVersion

String engineVersion

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

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.

Class com.amazonaws.services.elasticache.model.PurchaseReservedCacheNodesOfferingRequest

class PurchaseReservedCacheNodesOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheNodeCount

Integer cacheNodeCount

The number of cache node instances to reserve.

Default: 1

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

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

The ID of the reserved cache node offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

Class com.amazonaws.services.elasticache.model.RebootCacheClusterRequest

class 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.SdkInternalList<String> 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

class 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

class 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.SdkInternalList<String> 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

class RemoveTagsFromResourceResult extends Object implements Serializable

Serialized Fields

tagList

com.amazonaws.internal.SdkInternalList<Tag> tagList

A list of cost allocation tags as key-value pairs.

Class com.amazonaws.services.elasticache.model.ReplicationGroup

class ReplicationGroup extends Object implements Serializable

Serialized Fields

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.

description

String description

The description of the replication group.

memberClusters

com.amazonaws.internal.SdkInternalList<String> memberClusters

The names of all the cache clusters that are part of this replication group.

nodeGroups

com.amazonaws.internal.SdkInternalList<NodeGroup> nodeGroups

A single element list with information about the nodes in the replication group.

pendingModifiedValues

ReplicationGroupPendingModifiedValues pendingModifiedValues

A group of settings to be applied to the replication group, either immediately or during the next maintenance window.

replicationGroupId

String replicationGroupId

The identifier for the replication group.

snapshottingClusterId

String snapshottingClusterId

The cache cluster ID that is used as the daily snapshot source for the replication group.

status

String status

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

Exception Class com.amazonaws.services.elasticache.model.ReplicationGroupAlreadyExistsException

class ReplicationGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.ReplicationGroupNotFoundException

class ReplicationGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.ReplicationGroupPendingModifiedValues

class ReplicationGroupPendingModifiedValues extends Object implements Serializable

Serialized Fields

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.

primaryClusterId

String primaryClusterId

The primary cluster ID which will be applied immediately (if --apply-immediately was specified), or during the next maintenance window.

Class com.amazonaws.services.elasticache.model.ReservedCacheNode

class ReservedCacheNode extends Object implements Serializable

Serialized Fields

cacheNodeCount

Integer cacheNodeCount

The number of cache nodes that have been reserved.

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.

duration

Integer duration

The duration of the reservation in seconds.

fixedPrice

Double fixedPrice

The fixed price charged for this reserved cache node.

offeringType

String offeringType

The offering type of this reserved cache node.

productDescription

String productDescription

The description of the reserved cache node.

recurringCharges

com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

The recurring price charged to run this reserved cache node.

reservedCacheNodeId

String reservedCacheNodeId

The unique identifier for the reservation.

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

The offering identifier.

startTime

Date startTime

The time the reservation started.

state

String state

The state of the reserved cache node.

usagePrice

Double usagePrice

The hourly price charged for this reserved cache node.

Exception Class com.amazonaws.services.elasticache.model.ReservedCacheNodeAlreadyExistsException

class ReservedCacheNodeAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.ReservedCacheNodeNotFoundException

class ReservedCacheNodeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.ReservedCacheNodeQuotaExceededException

class ReservedCacheNodeQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.ReservedCacheNodesOffering

class ReservedCacheNodesOffering extends Object implements Serializable

Serialized Fields

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.

offeringType

String offeringType

The offering type.

productDescription

String productDescription

The cache engine used by the offering.

recurringCharges

com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

The recurring price charged to run this reserved cache node.

reservedCacheNodesOfferingId

String reservedCacheNodesOfferingId

A unique identifier for the reserved cache node offering.

usagePrice

Double usagePrice

The hourly price charged for this offering.

Exception Class com.amazonaws.services.elasticache.model.ReservedCacheNodesOfferingNotFoundException

class ReservedCacheNodesOfferingNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.ResetCacheParameterGroupRequest

class ResetCacheParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group to reset.

parameterNameValues

com.amazonaws.internal.SdkInternalList<ParameterNameValue> 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.

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

Class com.amazonaws.services.elasticache.model.ResetCacheParameterGroupResult

class ResetCacheParameterGroupResult extends Object implements Serializable

Serialized Fields

cacheParameterGroupName

String cacheParameterGroupName

The name of the cache parameter group.

Class com.amazonaws.services.elasticache.model.RevokeCacheSecurityGroupIngressRequest

class 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

class 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

class Snapshot extends Object implements Serializable

Serialized Fields

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

This parameter is currently disabled.

cacheClusterCreateTime

Date cacheClusterCreateTime

The date and time when the source cache cluster was created.

cacheClusterId

String cacheClusterId

The user-supplied identifier of the source cache cluster.

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.

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.

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.

nodeSnapshots

com.amazonaws.internal.SdkInternalList<NodeSnapshot> nodeSnapshots

A list of the cache nodes in 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.

port

Integer port

The port number used by each cache nodes in the source cache cluster.

preferredAvailabilityZone

String preferredAvailabilityZone

The name of the Availability Zone in which the source cache cluster is located.

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

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.

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.

snapshotSource

String snapshotSource

Indicates whether the snapshot is from an automatic backup ( automated) or was created manually (manual).

snapshotStatus

String snapshotStatus

The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.

snapshotWindow

String snapshotWindow

The daily time range during which ElastiCache takes daily snapshots of the source cache cluster.

topicArn

String topicArn

The Amazon Resource Name (ARN) for the topic used by the source cache cluster for publishing notifications.

vpcId

String vpcId

The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group for the source cache cluster.

Exception Class com.amazonaws.services.elasticache.model.SnapshotAlreadyExistsException

class SnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.SnapshotFeatureNotSupportedException

class SnapshotFeatureNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.SnapshotNotFoundException

class SnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.SnapshotQuotaExceededException

class SnapshotQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.Subnet

class Subnet extends Object implements Serializable

Serialized Fields

subnetAvailabilityZone

AvailabilityZone subnetAvailabilityZone

The Availability Zone associated with the subnet.

subnetIdentifier

String subnetIdentifier

The unique identifier for the subnet.

Exception Class com.amazonaws.services.elasticache.model.SubnetInUseException

class SubnetInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticache.model.Tag

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

Exception Class com.amazonaws.services.elasticache.model.TagNotFoundException

class TagNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticache.model.TagQuotaPerResourceExceededException

class TagQuotaPerResourceExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.elasticbeanstalk.model

Class com.amazonaws.services.elasticbeanstalk.model.AbortEnvironmentUpdateRequest

class 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.AbortEnvironmentUpdateResult

class AbortEnvironmentUpdateResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.ApplicationDescription

class ApplicationDescription extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application.

configurationTemplates

com.amazonaws.internal.SdkInternalList<String> configurationTemplates

The names of the configuration templates associated with this application.

dateCreated

Date dateCreated

The date when the application was created.

dateUpdated

Date dateUpdated

The date when the application was last modified.

description

String description

User-defined description of the application.

versions

com.amazonaws.internal.SdkInternalList<String> versions

The names of the versions for this application.

Class com.amazonaws.services.elasticbeanstalk.model.ApplicationMetrics

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

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.

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.

Class com.amazonaws.services.elasticbeanstalk.model.ApplicationVersionDescription

class ApplicationVersionDescription extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with this release.

dateCreated

Date dateCreated

The creation date of the application version.

dateUpdated

Date dateUpdated

The last modified date of the application version.

description

String description

The description of this application version.

sourceBundle

S3Location sourceBundle

The location where the source bundle is located for this version.

status

String status

The processing status of the application version.

versionLabel

String versionLabel

A label uniquely identifying the version for the associated application.

Class com.amazonaws.services.elasticbeanstalk.model.ApplyEnvironmentManagedActionRequest

class ApplyEnvironmentManagedActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionId

String actionId

The action ID of the scheduled managed action to execute.

environmentId

String environmentId

The environment ID of the target environment.

environmentName

String environmentName

The name of the target environment.

Class com.amazonaws.services.elasticbeanstalk.model.ApplyEnvironmentManagedActionResult

class ApplyEnvironmentManagedActionResult extends Object implements Serializable

Serialized Fields

actionDescription

String actionDescription

A description of the managed action.

actionId

String actionId

The action ID 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

class AutoScalingGroup extends Object implements Serializable

Serialized Fields

name

String name

The name of the AutoScalingGroup .

Class com.amazonaws.services.elasticbeanstalk.model.CheckDNSAvailabilityRequest

class 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

class 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

class 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<String> 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

class ComposeEnvironmentsResult extends Object implements Serializable

Serialized Fields

environments

com.amazonaws.internal.SdkInternalList<EnvironmentDescription> environments

Returns an EnvironmentDescription list.

Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionDescription

class ConfigurationOptionDescription extends Object implements Serializable

Serialized Fields

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.

defaultValue

String defaultValue

The default value for this configuration option.

maxLength

Integer maxLength

If specified, the configuration option must be a string value no longer than this value.

maxValue

Integer maxValue

If specified, the configuration option must be a numeric value less than this value.

minValue

Integer minValue

If specified, the configuration option must be a numeric value greater than this value.

name

String name

The name of the configuration option.

namespace

String namespace

A unique namespace identifying the option's associated AWS resource.

regex

OptionRestrictionRegex regex

If specified, the configuration option must be a string value that satisfies this regular expression.

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

valueOptions

com.amazonaws.internal.SdkInternalList<String> valueOptions

If specified, values for the configuration option are selected from this list.

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.

Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationOptionSetting

class ConfigurationOptionSetting extends Object implements Serializable

Serialized Fields

namespace

String namespace

A unique namespace identifying the option's associated AWS resource.

optionName

String optionName

The name of the configuration option.

resourceName

String resourceName

A unique resource name for a time-based scaling configuration option.

value

String value

The current value for the configuration option.

Class com.amazonaws.services.elasticbeanstalk.model.ConfigurationSettingsDescription

class ConfigurationSettingsDescription extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with this configuration set.

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.

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.

description

String description

Describes this configuration set.

environmentName

String environmentName

If not null, the name of the environment for this configuration set.

optionSettings

com.amazonaws.internal.SdkInternalList<ConfigurationOptionSetting> optionSettings

A list of the configuration options and their values in this configuration set.

solutionStackName

String solutionStackName

The name of the solution stack this configuration set uses.

templateName

String templateName

If not null, the name of the configuration template for this configuration set.

Class com.amazonaws.services.elasticbeanstalk.model.CPUUtilization

class CPUUtilization extends Object implements Serializable

Serialized Fields

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.

nice

Double nice

Percentage of time that the CPU has spent in the Nice 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.

system

Double system

Percentage of time that the CPU has spent in the System state over the last 10 seconds.

user

Double user

Percentage of time that the CPU has spent in the User state over the last 10 seconds.

Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationRequest

class 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

class CreateApplicationResult extends Object implements Serializable

Serialized Fields

application

ApplicationDescription application

The ApplicationDescription of the application.

Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionRequest

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

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

description

String description

Describes this version.

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.

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.

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.

Class com.amazonaws.services.elasticbeanstalk.model.CreateApplicationVersionResult

class CreateApplicationVersionResult extends Object implements Serializable

Serialized Fields

applicationVersion

ApplicationVersionDescription applicationVersion

The ApplicationVersionDescription of the application version.

Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateRequest

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

description

String description

Describes this configuration.

environmentId

String environmentId

The ID of the environment used with this configuration template.

optionSettings

com.amazonaws.internal.SdkInternalList<ConfigurationOptionSetting> 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.

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.

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.

Class com.amazonaws.services.elasticbeanstalk.model.CreateConfigurationTemplateResult

class CreateConfigurationTemplateResult extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with this configuration set.

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.

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.

description

String description

Describes this configuration set.

environmentName

String environmentName

If not null, the name of the environment for this configuration set.

optionSettings

com.amazonaws.internal.SdkInternalList<ConfigurationOptionSetting> optionSettings

A list of the configuration options and their values in this configuration set.

solutionStackName

String solutionStackName

The name of the solution stack this configuration set uses.

templateName

String templateName

If not null, the name of the configuration template for this configuration set.

Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentRequest

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

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.

description

String description

Describes this environment.

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.

optionSettings

com.amazonaws.internal.SdkInternalList<ConfigurationOptionSetting> 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<OptionSpecification> optionsToRemove

A list of custom user-defined configuration options to remove from the configuration set for this new environment.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

This specifies the tags applied to resources in the environment.

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.

tier

EnvironmentTier tier

This specifies the tier to use for creating this 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.

Class com.amazonaws.services.elasticbeanstalk.model.CreateEnvironmentResult

class CreateEnvironmentResult extends Object implements Serializable

Serialized Fields

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.

applicationName

String applicationName

The name of the application associated with this environment.

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.

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.

environmentId

String environmentId

The ID of this environment.

environmentLinks

com.amazonaws.internal.SdkInternalList<EnvironmentLink> environmentLinks

A list of links to other environments in the same group.

environmentName

String environmentName

The name of this environment.

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.

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with 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.

templateName

String templateName

The name of the configuration template used to originally launch this environment.

tier

EnvironmentTier tier

Describes the current tier of this environment.

versionLabel

String versionLabel

The application version deployed in this environment.

Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationRequest

class CreateStorageLocationRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.CreateStorageLocationResult

class 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

class 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.DeleteApplicationResult

class DeleteApplicationResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationVersionRequest

class DeleteApplicationVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application to delete releases from.

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

versionLabel

String versionLabel

The label of the version to delete.

Class com.amazonaws.services.elasticbeanstalk.model.DeleteApplicationVersionResult

class DeleteApplicationVersionResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.DeleteConfigurationTemplateRequest

class 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.DeleteConfigurationTemplateResult

class DeleteConfigurationTemplateResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.DeleteEnvironmentConfigurationRequest

class 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.DeleteEnvironmentConfigurationResult

class DeleteEnvironmentConfigurationResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.Deployment

class Deployment extends Object implements Serializable

Serialized Fields

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.

deploymentTime

Date deploymentTime

For in-progress deployments, the time that the deloyment started.

For completed deployments, the time that the deployment ended.

status

String status

The status of the deployment:

• In Progress : The deployment is in progress.
• Deployed : The deployment succeeded.
• Failed : The deployment failed.

versionLabel

String versionLabel

The version label of the application version in the deployment.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationsRequest

class DescribeApplicationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationNames

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeApplicationsResult extends Object implements Serializable

Serialized Fields

applications

com.amazonaws.internal.SdkInternalList<ApplicationDescription> applications

This parameter contains a list of ApplicationDescription.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsRequest

class 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<String> versionLabels

If specified, restricts the returned descriptions to only include ones that have the specified version labels.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeApplicationVersionsResult

class DescribeApplicationVersionsResult extends Object implements Serializable

Serialized Fields

applicationVersions

com.amazonaws.internal.SdkInternalList<ApplicationVersionDescription> applicationVersions

List of ApplicationVersionDescription objects sorted by order of creation.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsRequest

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

environmentName

String environmentName

The name of the environment whose configuration options you want to describe.

options

com.amazonaws.internal.SdkInternalList<OptionSpecification> options

If specified, restricts the descriptions to only the specified options.

solutionStackName

String solutionStackName

The name of the solution stack whose configuration options you want to describe.

templateName

String templateName

The name of the configuration template whose configuration options you want to describe.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationOptionsResult

class DescribeConfigurationOptionsResult extends Object implements Serializable

Serialized Fields

options

com.amazonaws.internal.SdkInternalList<ConfigurationOptionDescription> options

A list of ConfigurationOptionDescription.

solutionStackName

String solutionStackName

The name of the solution stack these configuration options belong to.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsRequest

class DescribeConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The application for the environment or configuration template.

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.

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.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeConfigurationSettingsResult

class DescribeConfigurationSettingsResult extends Object implements Serializable

Serialized Fields

configurationSettings

com.amazonaws.internal.SdkInternalList<ConfigurationSettingsDescription> configurationSettings

A list of ConfigurationSettingsDescription.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthRequest

class DescribeEnvironmentHealthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentHealthResult

class DescribeEnvironmentHealthResult extends Object implements Serializable

Serialized Fields

applicationMetrics

ApplicationMetrics applicationMetrics

causes

com.amazonaws.internal.SdkInternalList<String> causes

Returns potential causes for the reported status.

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.

environmentName

String environmentName

The AWS Elastic Beanstalk environment name.

healthStatus

String healthStatus

Contains the response body with information about the health of the environment.

instancesHealth

InstanceHealthSummary instancesHealth

refreshedAt

Date refreshedAt

The date and time the information was last refreshed.

status

String status

Returns the health status value of the environment. For more information, see Health Colors and Statuses.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest

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

maxItems

Integer maxItems

The maximum number of items to return for a single request.

nextToken

String nextToken

The pagination token returned by a previous request.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResult

class DescribeEnvironmentManagedActionHistoryResult extends Object implements Serializable

Serialized Fields

managedActionHistoryItems

com.amazonaws.internal.SdkInternalList<ManagedActionHistoryItem> 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

class DescribeEnvironmentManagedActionsRequest 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.

status

String status

To show only actions with a particular status, specify a status.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionsResult

class DescribeEnvironmentManagedActionsResult extends Object implements Serializable

Serialized Fields

managedActions

com.amazonaws.internal.SdkInternalList<ManagedAction> managedActions

A list of upcoming and in-progress managed actions.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentResourcesRequest

class 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

class DescribeEnvironmentResourcesResult extends Object implements Serializable

Serialized Fields

environmentResources

EnvironmentResourceDescription environmentResources

A list of EnvironmentResourceDescription.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsRequest

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

environmentIds

com.amazonaws.internal.SdkInternalList<String> environmentIds

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified IDs.

environmentNames

com.amazonaws.internal.SdkInternalList<String> environmentNames

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the specified names.

includedDeletedBackTo

Date includedDeletedBackTo

If specified when IncludeDeleted is set to true , then environments deleted after this date are displayed.

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.

versionLabel

String versionLabel

If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated with this application version.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEnvironmentsResult

class DescribeEnvironmentsResult extends Object implements Serializable

Serialized Fields

environments

com.amazonaws.internal.SdkInternalList<EnvironmentDescription> environments

Returns an EnvironmentDescription list.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEventsRequest

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

endTime

Date endTime

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the EndTime.

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.

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.

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.

templateName

String templateName

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.

versionLabel

String versionLabel

If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeEventsResult

class DescribeEventsResult extends Object implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalList<EventDescription> 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

class DescribeInstancesHealthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeNames

com.amazonaws.internal.SdkInternalList<String> attributeNames

Specifies the response elements you wish to receive. If no attribute names are specified, AWS Elastic Beanstalk only returns a list of instances.

environmentId

String environmentId

Specifies the AWS Elastic Beanstalk environment ID.

environmentName

String environmentName

Specifies the AWS Elastic Beanstalk environment name.

nextToken

String nextToken

Specifies the next token of the request.

Class com.amazonaws.services.elasticbeanstalk.model.DescribeInstancesHealthResult

class DescribeInstancesHealthResult extends Object implements Serializable

Serialized Fields

instanceHealthList

com.amazonaws.internal.SdkInternalList<SingleInstanceHealth> instanceHealthList

Contains the response body with information about the health of the instance.

nextToken

String nextToken

The next token.

refreshedAt

Date refreshedAt

The date and time the information was last refreshed.

Exception Class com.amazonaws.services.elasticbeanstalk.model.ElasticBeanstalkServiceException

class ElasticBeanstalkServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentDescription

class EnvironmentDescription extends Object implements Serializable

Serialized Fields

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.

applicationName

String applicationName

The name of the application associated with this environment.

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.

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.

environmentId

String environmentId

The ID of this environment.

environmentLinks

com.amazonaws.internal.SdkInternalList<EnvironmentLink> environmentLinks

A list of links to other environments in the same group.

environmentName

String environmentName

The name of this environment.

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.

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with 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.

templateName

String templateName

The name of the configuration template used to originally launch this environment.

tier

EnvironmentTier tier

Describes the current tier of this environment.

versionLabel

String versionLabel

The application version deployed in this environment.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentInfoDescription

class EnvironmentInfoDescription extends Object implements Serializable

Serialized Fields

ec2InstanceId

String ec2InstanceId

The Amazon EC2 Instance ID for this information.

infoType

String infoType

The type of information retrieved.

message

String message

The retrieved information.

sampleTimestamp

Date sampleTimestamp

The time stamp when this information was retrieved.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentLink

class EnvironmentLink extends Object implements Serializable

Serialized Fields

environmentName

String environmentName

The name of the linked environment (the dependency).

linkName

String linkName

The name of the link.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourceDescription

class EnvironmentResourceDescription extends Object implements Serializable

Serialized Fields

autoScalingGroups

com.amazonaws.internal.SdkInternalList<AutoScalingGroup> autoScalingGroups

The AutoScalingGroups used by this environment.

environmentName

String environmentName

The name of the environment.

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The Amazon EC2 instances used by this environment.

launchConfigurations

com.amazonaws.internal.SdkInternalList<LaunchConfiguration> launchConfigurations

The Auto Scaling launch configurations in use by this environment.

loadBalancers

com.amazonaws.internal.SdkInternalList<LoadBalancer> loadBalancers

The LoadBalancers in use by this environment.

queues

com.amazonaws.internal.SdkInternalList<Queue> queues

The queues used by this environment.

triggers

com.amazonaws.internal.SdkInternalList<Trigger> triggers

The AutoScaling triggers in use by this environment.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentResourcesDescription

class EnvironmentResourcesDescription extends Object implements Serializable

Serialized Fields

loadBalancer

LoadBalancerDescription loadBalancer

Describes the LoadBalancer.

Class com.amazonaws.services.elasticbeanstalk.model.EnvironmentTier

class 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

class EventDescription extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The application associated with the event.

environmentName

String environmentName

The name of the environment associated with this event.

eventDate

Date eventDate

The date when the event occurred.

message

String message

The event message.

requestId

String requestId

The web service request ID for the activity of this event.

severity

String severity

The severity level of this event.

templateName

String templateName

The name of the configuration associated with this event.

versionLabel

String versionLabel

The release label for the application version associated with this event.

Class com.amazonaws.services.elasticbeanstalk.model.Instance

class Instance extends Object implements Serializable

Serialized Fields

id

String id

The ID of the Amazon EC2 instance.

Class com.amazonaws.services.elasticbeanstalk.model.InstanceHealthSummary

class InstanceHealthSummary extends Object implements Serializable

Serialized Fields

degraded

Integer degraded

Red. The health agent is reporting a high number of request failures or other issues for an instance or environment.

info

Integer info

Green. An operation is in progress on an instance.

noData

Integer noData

Grey. AWS Elastic Beanstalk and the health agent are reporting no data on an instance.

ok

Integer ok

Green. An instance is passing health checks and the health agent is not reporting any problems.

pending

Integer pending

Grey. An operation is in progress on an instance within the command timeout.

severe

Integer severe

Red. The health agent is reporting a very high number of request failures or other issues for an instance or environment.

unknown

Integer unknown

Grey. AWS Elastic Beanstalk and the health agent are reporting an insufficient amount of data 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.

Exception Class com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException

class InsufficientPrivilegesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticbeanstalk.model.InvalidRequestException

class InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticbeanstalk.model.Latency

class Latency extends Object implements Serializable

Serialized Fields

p10

Double p10

The average latency for the slowest 90 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.

p75

Double p75

The average latency for the slowest 25 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.

p90

Double p90

The average latency for the slowest 10 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.

p99

Double p99

The average latency for the slowest 1 percent of requests over the last 10 seconds.

p999

Double p999

The average latency for the slowest 0.1 percent of requests over the last 10 seconds.

Class com.amazonaws.services.elasticbeanstalk.model.LaunchConfiguration

class LaunchConfiguration extends Object implements Serializable

Serialized Fields

name

String name

The name of the launch configuration.

Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksRequest

class ListAvailableSolutionStacksRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.ListAvailableSolutionStacksResult

class ListAvailableSolutionStacksResult extends Object implements Serializable

Serialized Fields

solutionStackDetails

com.amazonaws.internal.SdkInternalList<SolutionStackDescription> solutionStackDetails

A list of available solution stacks and their SolutionStackDescription.

solutionStacks

com.amazonaws.internal.SdkInternalList<String> solutionStacks

A list of available solution stacks.

Class com.amazonaws.services.elasticbeanstalk.model.Listener

class Listener extends Object implements Serializable

Serialized Fields

port

Integer port

The port that is used by the Listener.

protocol

String protocol

The protocol that is used by the Listener.

Class com.amazonaws.services.elasticbeanstalk.model.LoadBalancer

class LoadBalancer extends Object implements Serializable

Serialized Fields

name

String name

The name of the LoadBalancer.

Class com.amazonaws.services.elasticbeanstalk.model.LoadBalancerDescription

class LoadBalancerDescription extends Object implements Serializable

Serialized Fields

domain

String domain

The domain name of the LoadBalancer.

listeners

com.amazonaws.internal.SdkInternalList<Listener> listeners

A list of Listeners used by the LoadBalancer.

loadBalancerName

String loadBalancerName

The name of the LoadBalancer.

Class com.amazonaws.services.elasticbeanstalk.model.ManagedAction

class ManagedAction extends Object implements Serializable

Serialized Fields

actionDescription

String actionDescription

A description of the managed action.

actionId

String actionId

A unique identifier for 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

class ManagedActionHistoryItem extends Object implements Serializable

Serialized Fields

actionDescription

String actionDescription

A description of the managed action.

actionId

String actionId

A unique identifier for the managed action.

actionType

String actionType

The type of the managed action.

executedTime

Date executedTime

The date and time that the action started executing.

failureDescription

String failureDescription

If the action failed, a description of the failure.

failureType

String failureType

If the action failed, the type of failure.

finishedTime

Date finishedTime

The date and time that the action finished executing.

status

String status

The status of the action.

Exception Class com.amazonaws.services.elasticbeanstalk.model.ManagedActionInvalidStateException

class ManagedActionInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticbeanstalk.model.OperationInProgressException

class OperationInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticbeanstalk.model.OptionRestrictionRegex

class OptionRestrictionRegex extends Object implements Serializable

Serialized Fields

label

String label

A unique name representing this regular expression.

pattern

String pattern

The regular expression pattern that a string configuration option value with this restriction must match.

Class com.amazonaws.services.elasticbeanstalk.model.OptionSpecification

class OptionSpecification extends Object implements Serializable

Serialized Fields

namespace

String namespace

A unique namespace identifying the option's associated AWS resource.

optionName

String optionName

The name of the configuration option.

resourceName

String resourceName

A unique resource name for a time-based scaling configuration option.

Class com.amazonaws.services.elasticbeanstalk.model.Queue

class 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

class 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.RebuildEnvironmentResult

class RebuildEnvironmentResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.RequestEnvironmentInfoRequest

class 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.RequestEnvironmentInfoResult

class RequestEnvironmentInfoResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.RestartAppServerRequest

class 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.RestartAppServerResult

class RestartAppServerResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.RetrieveEnvironmentInfoRequest

class 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

class RetrieveEnvironmentInfoResult extends Object implements Serializable

Serialized Fields

environmentInfo

com.amazonaws.internal.SdkInternalList<EnvironmentInfoDescription> environmentInfo

The EnvironmentInfoDescription of the environment.

Class com.amazonaws.services.elasticbeanstalk.model.S3Location

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

Exception Class com.amazonaws.services.elasticbeanstalk.model.S3LocationNotInServiceRegionException

class S3LocationNotInServiceRegionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticbeanstalk.model.S3SubscriptionRequiredException

class S3SubscriptionRequiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticbeanstalk.model.SingleInstanceHealth

class SingleInstanceHealth extends Object implements Serializable

Serialized Fields

applicationMetrics

ApplicationMetrics applicationMetrics

availabilityZone

String availabilityZone

The availability zone in which the instance runs.

causes

com.amazonaws.internal.SdkInternalList<String> causes

Represents the causes, which provide more information about the current health status.

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.

deployment

Deployment deployment

Information about the most recent deployment to an instance.

healthStatus

String healthStatus

Returns the health status of the specified instance. For more information, see Health Colors and Statuses.

instanceId

String instanceId

The ID of the Amazon EC2 instance.

instanceType

String instanceType

The instance's type.

launchedAt

Date launchedAt

The time at which the EC2 instance was launched.

system

SystemStatus system

Class com.amazonaws.services.elasticbeanstalk.model.SolutionStackDescription

class SolutionStackDescription extends Object implements Serializable

Serialized Fields

permittedFileTypes

com.amazonaws.internal.SdkInternalList<String> permittedFileTypes

The permitted file types allowed for a solution stack.

solutionStackName

String solutionStackName

The name of the solution stack.

Exception Class com.amazonaws.services.elasticbeanstalk.model.SourceBundleDeletionException

class SourceBundleDeletionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticbeanstalk.model.SourceConfiguration

class 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

class 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

class SwapEnvironmentCNAMEsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.elasticbeanstalk.model.SwapEnvironmentCNAMEsResult

class SwapEnvironmentCNAMEsResult extends Object implements Serializable

Class com.amazonaws.services.elasticbeanstalk.model.SystemStatus

class SystemStatus extends Object implements Serializable

Serialized Fields

cPUUtilization

CPUUtilization cPUUtilization

loadAverage

com.amazonaws.internal.SdkInternalList<Double> 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

class 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

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

forceTerminate

Boolean forceTerminate

Terminates the target environment even if another environment in the same group is dependent on it.

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

Class com.amazonaws.services.elasticbeanstalk.model.TerminateEnvironmentResult

class TerminateEnvironmentResult extends Object implements Serializable

Serialized Fields

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.

applicationName

String applicationName

The name of the application associated with this environment.

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.

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.

environmentId

String environmentId

The ID of this environment.

environmentLinks

com.amazonaws.internal.SdkInternalList<EnvironmentLink> environmentLinks

A list of links to other environments in the same group.

environmentName

String environmentName

The name of this environment.

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.

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with 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.

templateName

String templateName

The name of the configuration template used to originally launch this environment.

tier

EnvironmentTier tier

Describes the current tier of this environment.

versionLabel

String versionLabel

The application version deployed in this environment.

Exception Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationsException

class TooManyApplicationsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationVersionsException

class TooManyApplicationVersionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticbeanstalk.model.TooManyBucketsException

class TooManyBucketsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticbeanstalk.model.TooManyConfigurationTemplatesException

class TooManyConfigurationTemplatesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticbeanstalk.model.TooManyEnvironmentsException

class TooManyEnvironmentsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticbeanstalk.model.Trigger

class Trigger extends Object implements Serializable

Serialized Fields

name

String name

The name of the trigger.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationRequest

class 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

class UpdateApplicationResult extends Object implements Serializable

Serialized Fields

application

ApplicationDescription application

The ApplicationDescription of the application.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionRequest

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

description

String description

A new description for this release.

versionLabel

String versionLabel

The name of the version to update.

If no application version is found with this label, UpdateApplication returns an InvalidParameterValue error.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateApplicationVersionResult

class UpdateApplicationVersionResult extends Object implements Serializable

Serialized Fields

applicationVersion

ApplicationVersionDescription applicationVersion

The ApplicationVersionDescription of the application version.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateRequest

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

description

String description

A new description for the configuration.

optionSettings

com.amazonaws.internal.SdkInternalList<ConfigurationOptionSetting> optionSettings

A list of configuration option settings to update with the new specified option value.

optionsToRemove

com.amazonaws.internal.SdkInternalList<OptionSpecification> optionsToRemove

A list of configuration options to remove from the configuration set.

Constraint: You can remove only UserDefined configuration options.

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.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateConfigurationTemplateResult

class UpdateConfigurationTemplateResult extends Object implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application associated with this configuration set.

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.

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.

description

String description

Describes this configuration set.

environmentName

String environmentName

If not null, the name of the environment for this configuration set.

optionSettings

com.amazonaws.internal.SdkInternalList<ConfigurationOptionSetting> optionSettings

A list of the configuration options and their values in this configuration set.

solutionStackName

String solutionStackName

The name of the solution stack this configuration set uses.

templateName

String templateName

If not null, the name of the configuration template for this configuration set.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentRequest

class UpdateEnvironmentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application with which the environment is associated.

description

String description

If this parameter is specified, AWS Elastic Beanstalk updates the description of this environment.

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.

optionSettings

com.amazonaws.internal.SdkInternalList<ConfigurationOptionSetting> 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<OptionSpecification> optionsToRemove

A list of custom user-defined configuration options to remove from the configuration set for this environment.

solutionStackName

String solutionStackName

This specifies the platform version that the environment will run after the environment is updated.

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.

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.

Class com.amazonaws.services.elasticbeanstalk.model.UpdateEnvironmentResult

class UpdateEnvironmentResult extends Object implements Serializable

Serialized Fields

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.

applicationName

String applicationName

The name of the application associated with this environment.

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.

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.

environmentId

String environmentId

The ID of this environment.

environmentLinks

com.amazonaws.internal.SdkInternalList<EnvironmentLink> environmentLinks

A list of links to other environments in the same group.

environmentName

String environmentName

The name of this environment.

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.

solutionStackName

String solutionStackName

The name of the SolutionStack deployed with 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.

templateName

String templateName

The name of the configuration template used to originally launch this environment.

tier

EnvironmentTier tier

Describes the current tier of this environment.

versionLabel

String versionLabel

The application version deployed in this environment.

Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsRequest

class ValidateConfigurationSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

applicationName

String applicationName

The name of the application that the configuration template or environment belongs to.

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<ConfigurationOptionSetting> optionSettings

A list of the options and desired values to evaluate.

templateName

String templateName

The name of the configuration template to validate the settings against.

Condition: You cannot specify both this and an environment name.

Class com.amazonaws.services.elasticbeanstalk.model.ValidateConfigurationSettingsResult

class ValidateConfigurationSettingsResult extends Object implements Serializable

Serialized Fields

messages

com.amazonaws.internal.SdkInternalList<ValidationMessage> messages

A list of ValidationMessage.

Class com.amazonaws.services.elasticbeanstalk.model.ValidationMessage

class ValidationMessage extends Object implements Serializable

Serialized Fields

message

String message

A message describing the error or warning.

namespace

String namespace

optionName

String optionName

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.

Package com.amazonaws.services.elasticfilesystem.model

Exception Class com.amazonaws.services.elasticfilesystem.model.BadRequestException

class BadRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Class com.amazonaws.services.elasticfilesystem.model.CreateFileSystemRequest

class 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

class CreateFileSystemResult extends Object implements Serializable

Serialized Fields

creationTime

Date creationTime

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

creationToken

String creationToken

Opaque string specified in the request.

fileSystemId

String fileSystemId

The file system ID assigned by Amazon EFS.

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.

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.

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

class CreateMountTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fileSystemId

String fileSystemId

The ID of the file system for which to create the mount target.

ipAddress

String ipAddress

A valid IPv4 address within the address range of the specified subnet.

securityGroups

com.amazonaws.internal.SdkInternalList<String> securityGroups

Up to 5 VPC security group IDs, of the form "sg-xxxxxxxx". These must be for the same VPC as subnet specified.

subnetId

String subnetId

The ID of the subnet to add the mount target in.

Class com.amazonaws.services.elasticfilesystem.model.CreateMountTargetResult

class CreateMountTargetResult extends Object implements Serializable

Serialized Fields

fileSystemId

String fileSystemId

The ID of the file system for which the mount target is intended.

ipAddress

String ipAddress

The address at which the file system may be mounted via the mount target.

lifeCycleState

String lifeCycleState

The lifecycle state the mount target is in.

mountTargetId

String mountTargetId

The system-assigned mount target ID.

networkInterfaceId

String networkInterfaceId

The ID of the network interface that Amazon EFS created when it created the mount target.

ownerId

String ownerId

The AWS account ID that owns the resource.

subnetId

String subnetId

The ID of the subnet that the mount target is in.

Class com.amazonaws.services.elasticfilesystem.model.CreateTagsRequest

class 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<Tag> tags

An array of Tag objects to add. Each Tag object is a key-value pair.

Class com.amazonaws.services.elasticfilesystem.model.CreateTagsResult

class CreateTagsResult extends Object implements Serializable

Class com.amazonaws.services.elasticfilesystem.model.DeleteFileSystemRequest

class 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.DeleteFileSystemResult

class DeleteFileSystemResult extends Object implements Serializable

Class com.amazonaws.services.elasticfilesystem.model.DeleteMountTargetRequest

class 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.DeleteMountTargetResult

class DeleteMountTargetResult extends Object implements Serializable

Class com.amazonaws.services.elasticfilesystem.model.DeleteTagsRequest

class 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<String> tagKeys

A list of tag keys to delete.

Class com.amazonaws.services.elasticfilesystem.model.DeleteTagsResult

class DeleteTagsResult extends Object implements Serializable

Exception Class com.amazonaws.services.elasticfilesystem.model.DependencyTimeoutException

class DependencyTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemsRequest

class DescribeFileSystemsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

Class com.amazonaws.services.elasticfilesystem.model.DescribeFileSystemsResult

class DescribeFileSystemsResult extends Object implements Serializable

Serialized Fields

fileSystems

com.amazonaws.internal.SdkInternalList<FileSystemDescription> fileSystems

An array of file system descriptions.

marker

String marker

A string, present if provided by caller in the request.

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

class 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

class DescribeMountTargetSecurityGroupsResult extends Object implements Serializable

Serialized Fields

securityGroups

com.amazonaws.internal.SdkInternalList<String> securityGroups

An array of security groups.

Class com.amazonaws.services.elasticfilesystem.model.DescribeMountTargetsRequest

class DescribeMountTargetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

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

class 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<MountTargetDescription> 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

class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fileSystemId

String fileSystemId

The ID of the file system whose tag set you want to retrieve.

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.

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.

Class com.amazonaws.services.elasticfilesystem.model.DescribeTagsResult

class DescribeTagsResult extends Object implements Serializable

Serialized Fields

marker

String marker

If the request included a Marker, the response returns that value in this field.

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Returns tags associated with the file system as an array of Tag objects.

Exception Class com.amazonaws.services.elasticfilesystem.model.FileSystemAlreadyExistsException

class FileSystemAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

fileSystemId

String fileSystemId

Class com.amazonaws.services.elasticfilesystem.model.FileSystemDescription

class FileSystemDescription extends Object implements Serializable

Serialized Fields

creationTime

Date creationTime

The time at which the file system was created, in seconds, since 1970-01-01T00:00:00Z.

creationToken

String creationToken

Opaque string specified in the request.

fileSystemId

String fileSystemId

The file system ID assigned by Amazon EFS.

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.

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.

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.

Exception Class com.amazonaws.services.elasticfilesystem.model.FileSystemInUseException

class FileSystemInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.FileSystemLimitExceededException

class FileSystemLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.FileSystemNotFoundException

class FileSystemNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Class com.amazonaws.services.elasticfilesystem.model.FileSystemSize

class FileSystemSize extends Object implements Serializable

Serialized Fields

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.

value

Long value

The latest known metered size, in bytes, of data stored in the file system.

Exception Class com.amazonaws.services.elasticfilesystem.model.IncorrectFileSystemLifeCycleStateException

class IncorrectFileSystemLifeCycleStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.IncorrectMountTargetStateException

class IncorrectMountTargetStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.InternalServerErrorException

class InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.IpAddressInUseException

class IpAddressInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Class com.amazonaws.services.elasticfilesystem.model.ModifyMountTargetSecurityGroupsRequest

class 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<String> securityGroups

An array of up to five VPC security group IDs.

Class com.amazonaws.services.elasticfilesystem.model.ModifyMountTargetSecurityGroupsResult

class ModifyMountTargetSecurityGroupsResult extends Object implements Serializable

Exception Class com.amazonaws.services.elasticfilesystem.model.MountTargetConflictException

class MountTargetConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Class com.amazonaws.services.elasticfilesystem.model.MountTargetDescription

class MountTargetDescription extends Object implements Serializable

Serialized Fields

fileSystemId

String fileSystemId

The ID of the file system for which the mount target is intended.

ipAddress

String ipAddress

The address at which the file system may be mounted via the mount target.

lifeCycleState

String lifeCycleState

The lifecycle state the mount target is in.

mountTargetId

String mountTargetId

The system-assigned mount target ID.

networkInterfaceId

String networkInterfaceId

The ID of the network interface that Amazon EFS created when it created the mount target.

ownerId

String ownerId

The AWS account ID that owns the resource.

subnetId

String subnetId

The ID of the subnet that the mount target is in.

Exception Class com.amazonaws.services.elasticfilesystem.model.MountTargetNotFoundException

class MountTargetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.NetworkInterfaceLimitExceededException

class NetworkInterfaceLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.NoFreeAddressesInSubnetException

class NoFreeAddressesInSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.SecurityGroupLimitExceededException

class SecurityGroupLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.SecurityGroupNotFoundException

class SecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Exception Class com.amazonaws.services.elasticfilesystem.model.SubnetNotFoundException

class SubnetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

errorCode

String errorCode

Class com.amazonaws.services.elasticfilesystem.model.Tag

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

Exception Class com.amazonaws.services.elasticfilesystem.model.UnsupportedAvailabilityZoneException

class 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

class AccessLog extends Object implements Serializable

Serialized Fields

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

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.

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

class 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

class AddTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> loadBalancerNames

The name of the load balancer. You can specify one load balancer only.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

The tags.

Class com.amazonaws.services.elasticloadbalancing.model.AddTagsResult

class AddTagsResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.AppCookieStickinessPolicy

class AppCookieStickinessPolicy extends Object implements Serializable

Serialized Fields

cookieName

String cookieName

The name of the application cookie used for stickiness.

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.

Class com.amazonaws.services.elasticloadbalancing.model.ApplySecurityGroupsToLoadBalancerRequest

class ApplySecurityGroupsToLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

securityGroups

com.amazonaws.internal.SdkInternalList<String> 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

class ApplySecurityGroupsToLoadBalancerResult extends Object implements Serializable

Serialized Fields

securityGroups

com.amazonaws.internal.SdkInternalList<String> securityGroups

The IDs of the security groups associated with the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.AttachLoadBalancerToSubnetsRequest

class AttachLoadBalancerToSubnetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

subnets

com.amazonaws.internal.SdkInternalList<String> 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

class AttachLoadBalancerToSubnetsResult extends Object implements Serializable

Serialized Fields

subnets

com.amazonaws.internal.SdkInternalList<String> subnets

The IDs of the subnets attached to the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.BackendServerDescription

class 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<String> policyNames

The names of the policies enabled for the back-end server.

Exception Class com.amazonaws.services.elasticloadbalancing.model.CertificateNotFoundException

class CertificateNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckRequest

class ConfigureHealthCheckRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

healthCheck

HealthCheck healthCheck

The configuration information for the new health check.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.ConfigureHealthCheckResult

class ConfigureHealthCheckResult extends Object implements Serializable

Serialized Fields

healthCheck

HealthCheck healthCheck

The updated health check.

Class com.amazonaws.services.elasticloadbalancing.model.ConnectionDraining

class 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

class 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

class CreateAppCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cookieName

String cookieName

The name of the application cookie used for stickiness.

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.

Class com.amazonaws.services.elasticloadbalancing.model.CreateAppCookieStickinessPolicyResult

class CreateAppCookieStickinessPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyRequest

class CreateLBCookieStickinessPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.elasticloadbalancing.model.CreateLBCookieStickinessPolicyResult

class CreateLBCookieStickinessPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersRequest

class CreateLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

listeners

com.amazonaws.internal.SdkInternalList<Listener> listeners

The listeners.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerListenersResult

class CreateLoadBalancerListenersResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyRequest

class CreateLoadBalancerPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

policyAttributes

com.amazonaws.internal.SdkInternalList<PolicyAttribute> policyAttributes

The attributes for the policy.

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.

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerPolicyResult

class CreateLoadBalancerPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.CreateLoadBalancerRequest

class CreateLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> 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.

listeners

com.amazonaws.internal.SdkInternalList<Listener> listeners

The listeners.

For more information, see Listeners for Your Load Balancer in the Elastic Load Balancing Developer Guide.

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.

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.

securityGroups

com.amazonaws.internal.SdkInternalList<String> securityGroups

The IDs of the security groups to assign to the load balancer.

subnets

com.amazonaws.internal.SdkInternalList<String> subnets

The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones.

tags

com.amazonaws.internal.SdkInternalList<Tag> 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

class CreateLoadBalancerResult extends Object implements Serializable

Serialized Fields

dNSName

String dNSName

The DNS name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.CrossZoneLoadBalancing

class 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

class DeleteLoadBalancerListenersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

loadBalancerPorts

com.amazonaws.internal.SdkInternalList<Integer> loadBalancerPorts

The client port numbers of the listeners.

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerListenersResult

class DeleteLoadBalancerListenersResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerPolicyRequest

class 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

class DeleteLoadBalancerPolicyResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerRequest

class DeleteLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.DeleteLoadBalancerResult

class DeleteLoadBalancerResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerRequest

class DeregisterInstancesFromLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The IDs of the instances.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.DeregisterInstancesFromLoadBalancerResult

class DeregisterInstancesFromLoadBalancerResult extends Object implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The remaining instances registered with the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthRequest

class DescribeInstanceHealthRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The IDs of the instances.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeInstanceHealthResult

class DescribeInstanceHealthResult extends Object implements Serializable

Serialized Fields

instanceStates

com.amazonaws.internal.SdkInternalList<InstanceState> instanceStates

Information about the health of the instances.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesRequest

class DescribeLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerAttributesResult

class DescribeLoadBalancerAttributesResult extends Object implements Serializable

Serialized Fields

loadBalancerAttributes

LoadBalancerAttributes loadBalancerAttributes

Information about the load balancer attributes.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesRequest

class DescribeLoadBalancerPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

policyNames

com.amazonaws.internal.SdkInternalList<String> policyNames

The names of the policies.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPoliciesResult

class DescribeLoadBalancerPoliciesResult extends Object implements Serializable

Serialized Fields

policyDescriptions

com.amazonaws.internal.SdkInternalList<PolicyDescription> policyDescriptions

Information about the policies.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancerPolicyTypesRequest

class DescribeLoadBalancerPolicyTypesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyTypeNames

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeLoadBalancerPolicyTypesResult extends Object implements Serializable

Serialized Fields

policyTypeDescriptions

com.amazonaws.internal.SdkInternalList<PolicyTypeDescription> policyTypeDescriptions

Information about the policy types.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeLoadBalancersRequest

class DescribeLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeLoadBalancersResult extends Object implements Serializable

Serialized Fields

loadBalancerDescriptions

com.amazonaws.internal.SdkInternalList<LoadBalancerDescription> 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

class DescribeTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> loadBalancerNames

The names of the load balancers.

Class com.amazonaws.services.elasticloadbalancing.model.DescribeTagsResult

class DescribeTagsResult extends Object implements Serializable

Serialized Fields

tagDescriptions

com.amazonaws.internal.SdkInternalList<TagDescription> tagDescriptions

Information about the tags.

Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsRequest

class DetachLoadBalancerFromSubnetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

subnets

com.amazonaws.internal.SdkInternalList<String> subnets

The IDs of the subnets.

Class com.amazonaws.services.elasticloadbalancing.model.DetachLoadBalancerFromSubnetsResult

class DetachLoadBalancerFromSubnetsResult extends Object implements Serializable

Serialized Fields

subnets

com.amazonaws.internal.SdkInternalList<String> subnets

The IDs of the remaining subnets for the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerRequest

class DisableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

The Availability Zones.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.DisableAvailabilityZonesForLoadBalancerResult

class DisableAvailabilityZonesForLoadBalancerResult extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

The remaining Availability Zones for the load balancer.

Exception Class com.amazonaws.services.elasticloadbalancing.model.DuplicateListenerException

class DuplicateListenerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.DuplicateLoadBalancerNameException

class DuplicateLoadBalancerNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.DuplicatePolicyNameException

class DuplicatePolicyNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.DuplicateTagKeysException

class DuplicateTagKeysException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerRequest

class EnableAvailabilityZonesForLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

The Availability Zones. These must be in the same region as the load balancer.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.EnableAvailabilityZonesForLoadBalancerResult

class EnableAvailabilityZonesForLoadBalancerResult extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

The updated list of Availability Zones for the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.HealthCheck

class HealthCheck extends Object implements Serializable

Serialized Fields

healthyThreshold

Integer healthyThreshold

The number of consecutive health checks successes required before moving the instance to the Healthy state.

interval

Integer interval

The approximate interval, in seconds, between health checks of an individual instance.

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.

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.

Class com.amazonaws.services.elasticloadbalancing.model.Instance

class Instance extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The ID of the instance.

Class com.amazonaws.services.elasticloadbalancing.model.InstanceState

class InstanceState extends Object implements Serializable

Serialized Fields

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.

instanceId

String instanceId

The ID of the instance.

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

state

String state

The current state of the instance.

Valid values: InService | OutOfService | Unknown

Exception Class com.amazonaws.services.elasticloadbalancing.model.InvalidConfigurationRequestException

class InvalidConfigurationRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.InvalidInstanceException

class InvalidInstanceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.InvalidSchemeException

class InvalidSchemeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.InvalidSecurityGroupException

class InvalidSecurityGroupException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.InvalidSubnetException

class InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.LBCookieStickinessPolicy

class LBCookieStickinessPolicy extends Object implements Serializable

Serialized Fields

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.

policyName

String policyName

The name for the policy being created. The name must be unique within the set of policies for this load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.Listener

class Listener extends Object implements Serializable

Serialized Fields

instancePort

Integer instancePort

The port on which the instance is listening.

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.

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.

protocol

String protocol

The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

sSLCertificateId

String sSLCertificateId

The Amazon Resource Name (ARN) of the server certificate.

Class com.amazonaws.services.elasticloadbalancing.model.ListenerDescription

class ListenerDescription extends Object implements Serializable

Serialized Fields

listener

Listener listener

policyNames

com.amazonaws.internal.SdkInternalList<String> policyNames

The policies. If there are no policies enabled, the list is empty.

Exception Class com.amazonaws.services.elasticloadbalancing.model.ListenerNotFoundException

class ListenerNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributeNotFoundException

class LoadBalancerAttributeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerAttributes

class LoadBalancerAttributes extends Object implements Serializable

Serialized Fields

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.

additionalAttributes

com.amazonaws.internal.SdkInternalList<AdditionalAttribute> additionalAttributes

This parameter is reserved.

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.

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.

Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerDescription

class LoadBalancerDescription extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

The Availability Zones for the load balancer.

backendServerDescriptions

com.amazonaws.internal.SdkInternalList<BackendServerDescription> backendServerDescriptions

Information about the back-end servers.

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.

createdTime

Date createdTime

The date and time the load balancer was created.

dNSName

String dNSName

The external DNS name of the load balancer.

healthCheck

HealthCheck healthCheck

Information about the health checks conducted on the load balancer.

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The IDs of the instances for the load balancer.

listenerDescriptions

com.amazonaws.internal.SdkInternalList<ListenerDescription> listenerDescriptions

The listeners for the load balancer.

loadBalancerName

String loadBalancerName

The name of the load balancer.

policies

Policies policies

The policies defined for the load balancer.

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.

securityGroups

com.amazonaws.internal.SdkInternalList<String> securityGroups

The security groups for the load balancer. Valid only for load balancers in a VPC.

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.

subnets

com.amazonaws.internal.SdkInternalList<String> subnets

The IDs of the subnets for the load balancer.

vPCId

String vPCId

The ID of the VPC for the load balancer.

Exception Class com.amazonaws.services.elasticloadbalancing.model.LoadBalancerNotFoundException

class LoadBalancerNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesRequest

class ModifyLoadBalancerAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerAttributes

LoadBalancerAttributes loadBalancerAttributes

The attributes of the load balancer.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.ModifyLoadBalancerAttributesResult

class ModifyLoadBalancerAttributesResult extends Object implements Serializable

Serialized Fields

loadBalancerAttributes

LoadBalancerAttributes loadBalancerAttributes

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.Policies

class Policies extends Object implements Serializable

Serialized Fields

appCookieStickinessPolicies

com.amazonaws.internal.SdkInternalList<AppCookieStickinessPolicy> appCookieStickinessPolicies

The stickiness policies created using CreateAppCookieStickinessPolicy.

lBCookieStickinessPolicies

com.amazonaws.internal.SdkInternalList<LBCookieStickinessPolicy> lBCookieStickinessPolicies

The stickiness policies created using CreateLBCookieStickinessPolicy.

otherPolicies

com.amazonaws.internal.SdkInternalList<String> otherPolicies

The policies other than the stickiness policies.

Class com.amazonaws.services.elasticloadbalancing.model.PolicyAttribute

class 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

class 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

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

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

defaultValue

String defaultValue

The default value of the attribute, if applicable.

description

String description

A description of the attribute.

Class com.amazonaws.services.elasticloadbalancing.model.PolicyDescription

class PolicyDescription extends Object implements Serializable

Serialized Fields

policyAttributeDescriptions

com.amazonaws.internal.SdkInternalList<PolicyAttributeDescription> policyAttributeDescriptions

The policy attributes.

policyName

String policyName

The name of the policy.

policyTypeName

String policyTypeName

The name of the policy type.

Exception Class com.amazonaws.services.elasticloadbalancing.model.PolicyNotFoundException

class PolicyNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeDescription

class PolicyTypeDescription extends Object implements Serializable

Serialized Fields

description

String description

A description of the policy type.

policyAttributeTypeDescriptions

com.amazonaws.internal.SdkInternalList<PolicyAttributeTypeDescription> policyAttributeTypeDescriptions

The description of the policy attributes associated with the policies defined by Elastic Load Balancing.

policyTypeName

String policyTypeName

The name of the policy type.

Exception Class com.amazonaws.services.elasticloadbalancing.model.PolicyTypeNotFoundException

class PolicyTypeNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerRequest

class RegisterInstancesWithLoadBalancerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The IDs of the instances.

loadBalancerName

String loadBalancerName

The name of the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.RegisterInstancesWithLoadBalancerResult

class RegisterInstancesWithLoadBalancerResult extends Object implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

The updated list of instances for the load balancer.

Class com.amazonaws.services.elasticloadbalancing.model.RemoveTagsRequest

class RemoveTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loadBalancerNames

com.amazonaws.internal.SdkInternalList<String> loadBalancerNames

The name of the load balancer. You can specify a maximum of one load balancer name.

tags

com.amazonaws.internal.SdkInternalList<TagKeyOnly> tags

The list of tag keys to remove.

Class com.amazonaws.services.elasticloadbalancing.model.RemoveTagsResult

class RemoveTagsResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerListenerSSLCertificateRequest

class 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

class SetLoadBalancerListenerSSLCertificateResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesForBackendServerRequest

class SetLoadBalancerPoliciesForBackendServerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instancePort

Integer instancePort

The port number associated with the back-end server.

loadBalancerName

String loadBalancerName

The name of the load balancer.

policyNames

com.amazonaws.internal.SdkInternalList<String> 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

class SetLoadBalancerPoliciesForBackendServerResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.SetLoadBalancerPoliciesOfListenerRequest

class 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<String> 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

class SetLoadBalancerPoliciesOfListenerResult extends Object implements Serializable

Class com.amazonaws.services.elasticloadbalancing.model.SourceSecurityGroup

class SourceSecurityGroup extends Object implements Serializable

Serialized Fields

groupName

String groupName

The name of the security group.

ownerAlias

String ownerAlias

The owner of the security group.

Exception Class com.amazonaws.services.elasticloadbalancing.model.SubnetNotFoundException

class SubnetNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticloadbalancing.model.Tag

class 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

class TagDescription extends Object implements Serializable

Serialized Fields

loadBalancerName

String loadBalancerName

The name of the load balancer.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

The tags.

Class com.amazonaws.services.elasticloadbalancing.model.TagKeyOnly

class TagKeyOnly extends Object implements Serializable

Serialized Fields

key

String key

The name of the key.

Exception Class com.amazonaws.services.elasticloadbalancing.model.TooManyLoadBalancersException

class TooManyLoadBalancersException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.TooManyPoliciesException

class TooManyPoliciesException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticloadbalancing.model.TooManyTagsException

class TooManyTagsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.elasticmapreduce.model

Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsRequest

class AddInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceGroups

com.amazonaws.internal.SdkInternalList<InstanceGroupConfig> instanceGroups

Instance Groups to add.

jobFlowId

String jobFlowId

Job flow in which to add the instance groups.

Class com.amazonaws.services.elasticmapreduce.model.AddInstanceGroupsResult

class AddInstanceGroupsResult extends Object implements Serializable

Serialized Fields

instanceGroupIds

com.amazonaws.internal.SdkInternalList<String> instanceGroupIds

Instance group IDs of the newly created instance groups.

jobFlowId

String jobFlowId

The job flow ID in which the instance groups are added.

Class com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsRequest

class 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<StepConfig> steps

A list of StepConfig to be executed by the job flow.

Class com.amazonaws.services.elasticmapreduce.model.AddJobFlowStepsResult

class AddJobFlowStepsResult extends Object implements Serializable

Serialized Fields

stepIds

com.amazonaws.internal.SdkInternalList<String> stepIds

The identifiers of the list of steps added to the job flow.

Class com.amazonaws.services.elasticmapreduce.model.AddTagsRequest

class 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<Tag> 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

class AddTagsResult extends Object implements Serializable

Class com.amazonaws.services.elasticmapreduce.model.Application

class Application extends Object implements Serializable

Serialized Fields

additionalInfo

com.amazonaws.internal.SdkInternalMap<String,String> additionalInfo

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

args

com.amazonaws.internal.SdkInternalList<String> args

Arguments for Amazon EMR to pass to the application.

name

String name

The name of the application.

version

String version

The version of the application.

Class com.amazonaws.services.elasticmapreduce.model.BootstrapActionConfig

class 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

class BootstrapActionDetail extends Object implements Serializable

Serialized Fields

bootstrapActionConfig

BootstrapActionConfig bootstrapActionConfig

A description of the bootstrap action.

Class com.amazonaws.services.elasticmapreduce.model.Cluster

class Cluster extends Object implements Serializable

Serialized Fields

applications

com.amazonaws.internal.SdkInternalList<Application> applications

The applications installed on this cluster.

autoTerminate

Boolean autoTerminate

Specifies whether the cluster should terminate after completing all steps.

configurations

com.amazonaws.internal.SdkInternalList<Configuration> configurations

Amazon EMR releases 4.x or later.

The list of Configurations supplied to the EMR cluster.

ec2InstanceAttributes

Ec2InstanceAttributes ec2InstanceAttributes

id

String id

The unique identifier for the cluster.

logUri

String logUri

The path to the Amazon S3 location where logs for this cluster are stored.

masterPublicDnsName

String masterPublicDnsName

The public DNS name of the master EC2 instance.

name

String name

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

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.

requestedAmiVersion

String requestedAmiVersion

The AMI version requested for this cluster.

runningAmiVersion

String runningAmiVersion

The AMI version running on this cluster.

serviceRole

String serviceRole

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

status

ClusterStatus status

The current status details about the cluster.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

A list of tags associated with a cluster.

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.

Class com.amazonaws.services.elasticmapreduce.model.ClusterStateChangeReason

class 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

class 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

class ClusterSummary extends Object implements Serializable

Serialized Fields

id

String id

The unique identifier for the cluster.

name

String name

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

status

ClusterStatus status

The details about the current status of the cluster.

Class com.amazonaws.services.elasticmapreduce.model.ClusterTimeline

class ClusterTimeline extends Object implements Serializable

Serialized Fields

creationDateTime

Date creationDateTime

The creation date and time of the cluster.

endDateTime

Date endDateTime

The date and time when the cluster was terminated.

readyDateTime

Date readyDateTime

The date and time when the cluster was ready to execute steps.

Class com.amazonaws.services.elasticmapreduce.model.Command

class Command extends Object implements Serializable

Serialized Fields

args

com.amazonaws.internal.SdkInternalList<String> args

Arguments for Amazon EMR to pass to the command for execution.

name

String name

The name of the command.

scriptPath

String scriptPath

The Amazon S3 location of the command script.

Class com.amazonaws.services.elasticmapreduce.model.Configuration

class 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<Configuration> configurations

A list of configurations you apply to this configuration object.

properties

com.amazonaws.internal.SdkInternalMap<String,String> properties

A set of properties supplied to the Configuration object.

Class com.amazonaws.services.elasticmapreduce.model.DescribeClusterRequest

class DescribeClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterId

String clusterId

The identifier of the cluster to describe.

Class com.amazonaws.services.elasticmapreduce.model.DescribeClusterResult

class 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

class 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<String> jobFlowIds

Return only job flows whose job flow ID is contained in this list.

jobFlowStates

com.amazonaws.internal.SdkInternalList<String> jobFlowStates

Return only job flows whose state is contained in this list.

Class com.amazonaws.services.elasticmapreduce.model.DescribeJobFlowsResult

class DescribeJobFlowsResult extends Object implements Serializable

Serialized Fields

jobFlows

com.amazonaws.internal.SdkInternalList<JobFlowDetail> jobFlows

A list of job flows matching the parameters supplied.

Class com.amazonaws.services.elasticmapreduce.model.DescribeStepRequest

class 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

class 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

class EbsBlockDevice extends Object implements Serializable

Serialized Fields

device

String device

The device name that is exposed to the instance, such as /dev/sdh.

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.

Class com.amazonaws.services.elasticmapreduce.model.EbsBlockDeviceConfig

class 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

class EbsConfiguration extends Object implements Serializable

Serialized Fields

ebsBlockDeviceConfigs

com.amazonaws.internal.SdkInternalList<EbsBlockDeviceConfig> ebsBlockDeviceConfigs

ebsOptimized

Boolean ebsOptimized

Class com.amazonaws.services.elasticmapreduce.model.EbsVolume

class 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

class Ec2InstanceAttributes extends Object implements Serializable

Serialized Fields

additionalMasterSecurityGroups

com.amazonaws.internal.SdkInternalList<String> additionalMasterSecurityGroups

A list of additional Amazon EC2 security group IDs for the master node.

additionalSlaveSecurityGroups

com.amazonaws.internal.SdkInternalList<String> additionalSlaveSecurityGroups

A list of additional Amazon EC2 security group IDs for the slave nodes.

ec2AvailabilityZone

String ec2AvailabilityZone

The Availability Zone in which the cluster will run.

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.

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.

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.

serviceAccessSecurityGroup

String serviceAccessSecurityGroup

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

Class com.amazonaws.services.elasticmapreduce.model.HadoopJarStepConfig

class HadoopJarStepConfig extends Object implements Serializable

Serialized Fields

args

com.amazonaws.internal.SdkInternalList<String> args

A list of command line arguments passed to the JAR file's main function when executed.

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.

properties

com.amazonaws.internal.SdkInternalList<KeyValue> 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.

Class com.amazonaws.services.elasticmapreduce.model.HadoopStepConfig

class HadoopStepConfig extends Object implements Serializable

Serialized Fields

args

com.amazonaws.internal.SdkInternalList<String> args

The list of command line arguments to pass to the JAR file's main function for execution.

jar

String jar

The path to the JAR file that runs 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.

properties

com.amazonaws.internal.SdkInternalMap<String,String> 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.

Class com.amazonaws.services.elasticmapreduce.model.Instance

class Instance extends Object implements Serializable

Serialized Fields

ebsVolumes

com.amazonaws.internal.SdkInternalList<EbsVolume> ebsVolumes

The list of EBS volumes that are attached to this instance.

ec2InstanceId

String ec2InstanceId

The unique identifier of the instance in Amazon EC2.

id

String id

The unique identifier for the instance in Amazon EMR.

instanceGroupId

String instanceGroupId

The identifier of the instance group to which this instance belongs.

privateDnsName

String privateDnsName

The private DNS name of the instance.

privateIpAddress

String privateIpAddress

The private IP address of the instance.

publicDnsName

String publicDnsName

The public DNS name of the instance.

publicIpAddress

String publicIpAddress

The public IP address of the instance.

status

InstanceStatus status

The current status of the instance.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroup

class InstanceGroup extends Object implements Serializable

Serialized Fields

bidPrice

String bidPrice

The bid price for each EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

configurations

com.amazonaws.internal.SdkInternalList<Configuration> 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<EbsBlockDevice> 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.

id

String id

The identifier of the instance group.

instanceGroupType

String instanceGroupType

The type of the instance group. Valid values are MASTER, CORE or TASK.

instanceType

String instanceType

The EC2 instance type for all instances in the instance group.

market

String market

The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

name

String name

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

shrinkPolicy

ShrinkPolicy shrinkPolicy

Policy for customizing shrink operations.

status

InstanceGroupStatus status

The current status of the instance group.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupConfig

class InstanceGroupConfig extends Object implements Serializable

Serialized Fields

bidPrice

String bidPrice

Bid price for each Amazon EC2 instance in the instance group when launching nodes as Spot Instances, expressed in USD.

configurations

com.amazonaws.internal.SdkInternalList<Configuration> 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.

instanceCount

Integer instanceCount

Target number of instances for the instance group.

instanceRole

String instanceRole

The role of the instance group in the cluster.

instanceType

String instanceType

The Amazon EC2 instance type for all instances in the instance group.

market

String market

Market type of the Amazon EC2 instances used to create a cluster node.

name

String name

Friendly name given to the instance group.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupDetail

class InstanceGroupDetail extends Object implements Serializable

Serialized Fields

bidPrice

String bidPrice

Bid price for EC2 Instances when launching nodes as Spot Instances, expressed in USD.

creationDateTime

Date creationDateTime

The date/time the instance group was created.

endDateTime

Date endDateTime

The date/time the instance group was terminated.

instanceGroupId

String instanceGroupId

Unique identifier for the instance group.

instanceRequestCount

Integer instanceRequestCount

Target number of instances to run in the instance group.

instanceRole

String instanceRole

Instance group role in the cluster

instanceRunningCount

Integer instanceRunningCount

Actual count of running instances.

instanceType

String instanceType

Amazon EC2 Instance type.

lastStateChangeReason

String lastStateChangeReason

Details regarding the state of the instance group.

market

String market

Market type of the Amazon EC2 instances used to create a cluster node.

name

String name

Friendly name for the instance group.

readyDateTime

Date readyDateTime

The date/time the instance group was available to the cluster.

startDateTime

Date startDateTime

The date/time the instance group was started.

state

String state

State of instance group. The following values are deprecated: STARTING, TERMINATED, and FAILED.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupModifyConfig

class InstanceGroupModifyConfig extends Object implements Serializable

Serialized Fields

eC2InstanceIdsToTerminate

com.amazonaws.internal.SdkInternalList<String> eC2InstanceIdsToTerminate

The EC2 InstanceIds to terminate. Once you terminate the instances, the instance group will not return to its original requested size.

instanceCount

Integer instanceCount

Target size for the instance group.

instanceGroupId

String instanceGroupId

Unique ID of the instance group to expand or shrink.

shrinkPolicy

ShrinkPolicy shrinkPolicy

Policy for customizing shrink operations.

Class com.amazonaws.services.elasticmapreduce.model.InstanceGroupStateChangeReason

class 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

class 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

class InstanceGroupTimeline extends Object implements Serializable

Serialized Fields

creationDateTime

Date creationDateTime

The creation date and time of the instance group.

endDateTime

Date endDateTime

The date and time when the instance group terminated.

readyDateTime

Date readyDateTime

The date and time when the instance group became ready to perform tasks.

Class com.amazonaws.services.elasticmapreduce.model.InstanceResizePolicy

class InstanceResizePolicy extends Object implements Serializable

Serialized Fields

instancesToProtect

com.amazonaws.internal.SdkInternalList<String> instancesToProtect

Specific list of instances to be protected when shrinking an instance group.

instancesToTerminate

com.amazonaws.internal.SdkInternalList<String> instancesToTerminate

Specific list of instances to be terminated when shrinking an instance group.

instanceTerminationTimeout

Integer instanceTerminationTimeout

Decommissioning timeout override for the specific list of instances to be terminated.

Class com.amazonaws.services.elasticmapreduce.model.InstanceStateChangeReason

class 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

class 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

class InstanceTimeline extends Object implements Serializable

Serialized Fields

creationDateTime

Date creationDateTime

The creation date and time of the instance.

endDateTime

Date endDateTime

The date and time when the instance was terminated.

readyDateTime

Date readyDateTime

The date and time when the instance was ready to perform tasks.

Exception Class com.amazonaws.services.elasticmapreduce.model.InternalServerErrorException

class InternalServerErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticmapreduce.model.InternalServerException

class InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticmapreduce.model.InvalidRequestException

class 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

class JobFlowDetail extends Object implements Serializable

Serialized Fields

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.

bootstrapActions

com.amazonaws.internal.SdkInternalList<BootstrapActionDetail> bootstrapActions

A list of the bootstrap actions run by the job flow.

executionStatusDetail

JobFlowExecutionStatusDetail executionStatusDetail

Describes the execution status of the job flow.

instances

JobFlowInstancesDetail instances

Describes the Amazon EC2 instances of the job flow.

jobFlowId

String jobFlowId

The job flow identifier.

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.

logUri

String logUri

The location in Amazon S3 where log files for the job are stored.

name

String name

The name of the job flow.

serviceRole

String serviceRole

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

steps

com.amazonaws.internal.SdkInternalList<StepDetail> steps

A list of steps run by the job flow.

supportedProducts

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.elasticmapreduce.model.JobFlowExecutionStatusDetail

class JobFlowExecutionStatusDetail extends Object implements Serializable

Serialized Fields

creationDateTime

Date creationDateTime

The creation date and time of the job flow.

endDateTime

Date endDateTime

The completion date and time of the job flow.

lastStateChangeReason

String lastStateChangeReason

Description of the job flow last changed state.

readyDateTime

Date readyDateTime

The date and time when the job flow was ready to start running bootstrap actions.

startDateTime

Date startDateTime

The start date and time of the job flow.

state

String state

The state of the job flow.

Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesConfig

class JobFlowInstancesConfig extends Object implements Serializable

Serialized Fields

additionalMasterSecurityGroups

com.amazonaws.internal.SdkInternalList<String> additionalMasterSecurityGroups

A list of additional Amazon EC2 security group IDs for the master node.

additionalSlaveSecurityGroups

com.amazonaws.internal.SdkInternalList<String> additionalSlaveSecurityGroups

A list of additional Amazon EC2 security group IDs for the slave nodes.

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

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.

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.

instanceCount

Integer instanceCount

The number of Amazon EC2 instances used to execute the job flow.

instanceGroups

com.amazonaws.internal.SdkInternalList<InstanceGroupConfig> instanceGroups

Configuration for the job flow's instance groups.

keepJobFlowAliveWhenNoSteps

Boolean keepJobFlowAliveWhenNoSteps

Specifies whether the job flow should be kept alive after completing all steps.

masterInstanceType

String masterInstanceType

The EC2 instance type of the master node.

placement

PlacementType placement

The Availability Zone the job flow will run in.

serviceAccessSecurityGroup

String serviceAccessSecurityGroup

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

slaveInstanceType

String slaveInstanceType

The EC2 instance type of the slave nodes.

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.

Class com.amazonaws.services.elasticmapreduce.model.JobFlowInstancesDetail

class JobFlowInstancesDetail extends Object implements Serializable

Serialized Fields

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.

hadoopVersion

String hadoopVersion

The Hadoop version for the job flow.

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<InstanceGroupDetail> instanceGroups

Details about the job flow's instance groups.

keepJobFlowAliveWhenNoSteps

Boolean keepJobFlowAliveWhenNoSteps

Specifies whether the job flow should terminate after completing all steps.

masterInstanceId

String masterInstanceId

The Amazon EC2 instance identifier of the master node.

masterInstanceType

String masterInstanceType

The Amazon EC2 master node instance type.

masterPublicDnsName

String masterPublicDnsName

The DNS name of the master node.

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.

placement

PlacementType placement

The Amazon EC2 Availability Zone for the job flow.

slaveInstanceType

String slaveInstanceType

The Amazon EC2 slave node instance type.

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.

Class com.amazonaws.services.elasticmapreduce.model.KeyValue

class 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

class 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

class ListBootstrapActionsResult extends Object implements Serializable

Serialized Fields

bootstrapActions

com.amazonaws.internal.SdkInternalList<Command> 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

class ListClustersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterStates

com.amazonaws.internal.SdkInternalList<String> clusterStates

The cluster state filters to apply when listing clusters.

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 .

marker

String marker

The pagination token that indicates the next set of results to retrieve.

Class com.amazonaws.services.elasticmapreduce.model.ListClustersResult

class ListClustersResult extends Object implements Serializable

Serialized Fields

clusters

com.amazonaws.internal.SdkInternalList<ClusterSummary> 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

class 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

class ListInstanceGroupsResult extends Object implements Serializable

Serialized Fields

instanceGroups

com.amazonaws.internal.SdkInternalList<InstanceGroup> 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

class 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<String> instanceGroupTypes

The type of instance group for which to list the instances.

instanceStates

com.amazonaws.internal.SdkInternalList<String> instanceStates

A list of instance states that will filter the instances returned with this request.

marker

String marker

The pagination token that indicates the next set of results to retrieve.

Class com.amazonaws.services.elasticmapreduce.model.ListInstancesResult

class ListInstancesResult extends Object implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<Instance> 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

class ListStepsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterId

String clusterId

The identifier of the cluster for which to list the steps.

marker

String marker

The pagination token that indicates the next set of results to retrieve.

stepIds

com.amazonaws.internal.SdkInternalList<String> stepIds

The filter to limit the step list based on the identifier of the steps.

stepStates

com.amazonaws.internal.SdkInternalList<String> stepStates

The filter to limit the step list based on certain states.

Class com.amazonaws.services.elasticmapreduce.model.ListStepsResult

class ListStepsResult extends Object implements Serializable

Serialized Fields

marker

String marker

The pagination token that indicates the next set of results to retrieve.

steps

com.amazonaws.internal.SdkInternalList<StepSummary> steps

The filtered list of steps for the cluster.

Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceGroupsRequest

class ModifyInstanceGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceGroups

com.amazonaws.internal.SdkInternalList<InstanceGroupModifyConfig> instanceGroups

Instance groups to change.

Class com.amazonaws.services.elasticmapreduce.model.ModifyInstanceGroupsResult

class ModifyInstanceGroupsResult extends Object implements Serializable

Class com.amazonaws.services.elasticmapreduce.model.PlacementType

class 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

class 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<String> tagKeys

A list of tag keys to remove from a resource.

Class com.amazonaws.services.elasticmapreduce.model.RemoveTagsResult

class RemoveTagsResult extends Object implements Serializable

Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowRequest

class RunJobFlowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

applications

com.amazonaws.internal.SdkInternalList<Application> 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.

bootstrapActions

com.amazonaws.internal.SdkInternalList<BootstrapActionConfig> bootstrapActions

A list of bootstrap actions that will be run before Hadoop is started on the cluster nodes.

configurations

com.amazonaws.internal.SdkInternalList<Configuration> configurations

Amazon EMR releases 4.x or later.

The list of configurations supplied for the EMR cluster you are creating.

instances

JobFlowInstancesConfig instances

A specification of the number and type of Amazon EC2 instances on which to run the job flow.

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.

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.

name

String name

The name of the job flow.

newSupportedProducts

com.amazonaws.internal.SdkInternalList<SupportedProductConfig> 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.

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.

serviceRole

String serviceRole

The IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf.

steps

com.amazonaws.internal.SdkInternalList<StepConfig> steps

A list of steps to be executed by the job flow.

supportedProducts

com.amazonaws.internal.SdkInternalList<String> 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.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

A list of tags to associate with a cluster and propagate to Amazon EC2 instances.

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.

Class com.amazonaws.services.elasticmapreduce.model.RunJobFlowResult

class RunJobFlowResult extends Object implements Serializable

Serialized Fields

jobFlowId

String jobFlowId

An unique identifier for the job flow.

Class com.amazonaws.services.elasticmapreduce.model.ScriptBootstrapActionConfig

class ScriptBootstrapActionConfig extends Object implements Serializable

Serialized Fields

args

com.amazonaws.internal.SdkInternalList<String> args

A list of command line arguments to pass to the bootstrap action script.

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.

Class com.amazonaws.services.elasticmapreduce.model.SetTerminationProtectionRequest

class SetTerminationProtectionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobFlowIds

com.amazonaws.internal.SdkInternalList<String> 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.SetTerminationProtectionResult

class SetTerminationProtectionResult extends Object implements Serializable

Class com.amazonaws.services.elasticmapreduce.model.SetVisibleToAllUsersRequest

class SetVisibleToAllUsersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobFlowIds

com.amazonaws.internal.SdkInternalList<String> 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.SetVisibleToAllUsersResult

class SetVisibleToAllUsersResult extends Object implements Serializable

Class com.amazonaws.services.elasticmapreduce.model.ShrinkPolicy

class ShrinkPolicy extends Object implements Serializable

Serialized Fields

decommissionTimeout

Integer decommissionTimeout

The desired timeout for decommissioning an instance. Overrides the default YARN decommissioning timeout.

instanceResizePolicy

InstanceResizePolicy instanceResizePolicy

Custom policy for requesting termination protection or termination of specific instances when shrinking an instance group.

Class com.amazonaws.services.elasticmapreduce.model.Step

class Step extends Object implements Serializable

Serialized Fields

actionOnFailure

String actionOnFailure

This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.

config

HadoopStepConfig config

The Hadoop job configuration of the cluster step.

id

String id

The identifier of the cluster step.

name

String name

The name of the cluster step.

status

StepStatus status

The current execution status details of the cluster step.

Class com.amazonaws.services.elasticmapreduce.model.StepConfig

class StepConfig extends Object implements Serializable

Serialized Fields

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.

name

String name

The name of the job flow step.

Class com.amazonaws.services.elasticmapreduce.model.StepDetail

class StepDetail extends Object implements Serializable

Serialized Fields

executionStatusDetail

StepExecutionStatusDetail executionStatusDetail

The description of the step status.

stepConfig

StepConfig stepConfig

The step configuration.

Class com.amazonaws.services.elasticmapreduce.model.StepExecutionStatusDetail

class StepExecutionStatusDetail extends Object implements Serializable

Serialized Fields

creationDateTime

Date creationDateTime

The creation 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.

startDateTime

Date startDateTime

The start date and time of the step.

state

String state

The state of the job flow step.

Class com.amazonaws.services.elasticmapreduce.model.StepStateChangeReason

class 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

class 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

class StepSummary extends Object implements Serializable

Serialized Fields

actionOnFailure

String actionOnFailure

This specifies what action to take when the cluster step fails. Possible values are TERMINATE_CLUSTER, CANCEL_AND_WAIT, and CONTINUE.

config

HadoopStepConfig config

The Hadoop job configuration of the cluster step.

id

String id

The identifier of the cluster step.

name

String name

The name of the cluster step.

status

StepStatus status

The current execution status details of the cluster step.

Class com.amazonaws.services.elasticmapreduce.model.StepTimeline

class StepTimeline extends Object implements Serializable

Serialized Fields

creationDateTime

Date creationDateTime

The date and time when the cluster step was created.

endDateTime

Date endDateTime

The date and time when the cluster step execution completed or failed.

startDateTime

Date startDateTime

The date and time when the cluster step execution started.

Class com.amazonaws.services.elasticmapreduce.model.SupportedProductConfig

class SupportedProductConfig extends Object implements Serializable

Serialized Fields

args

com.amazonaws.internal.SdkInternalList<String> args

The list of user-supplied arguments.

name

String name

The name of the product configuration.

Class com.amazonaws.services.elasticmapreduce.model.Tag

class 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

class TerminateJobFlowsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

jobFlowIds

com.amazonaws.internal.SdkInternalList<String> jobFlowIds

A list of job flows to be shutdown.

Class com.amazonaws.services.elasticmapreduce.model.TerminateJobFlowsResult

class TerminateJobFlowsResult extends Object implements Serializable

Class com.amazonaws.services.elasticmapreduce.model.VolumeSpecification

class VolumeSpecification extends Object implements Serializable

Serialized Fields

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.

volumeType

String volumeType

The volume type. Volume types supported are gp2, io1, standard.

Package com.amazonaws.services.elasticsearch.model

Class com.amazonaws.services.elasticsearch.model.AccessPoliciesStatus

class 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

class AddTagsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aRN

String aRN

Specify the ARN for which you want to add the tags.

tagList

List<Tag> tagList

List of Tag that need to be added for the Elasticsearch domain.

Class com.amazonaws.services.elasticsearch.model.AddTagsResult

class AddTagsResult extends Object implements Serializable

Class com.amazonaws.services.elasticsearch.model.AdvancedOptionsStatus

class AdvancedOptionsStatus extends Object implements Serializable

Serialized Fields

options

Map<String,String> 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.

Exception Class com.amazonaws.services.elasticsearch.model.BaseException

class BaseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticsearch.model.CreateElasticsearchDomainRequest

class CreateElasticsearchDomainRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessPolicies

String accessPolicies

IAM access policy as a JSON-formatted string.

advancedOptions

Map<String,String> 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.

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

eBSOptions

EBSOptions eBSOptions

Options to enable, disable and specify the type and size of EBS storage volumes.

elasticsearchClusterConfig

ElasticsearchClusterConfig elasticsearchClusterConfig

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

snapshotOptions

SnapshotOptions snapshotOptions

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

Class com.amazonaws.services.elasticsearch.model.CreateElasticsearchDomainResult

class 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

class 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

class 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

class 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

class 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

class 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

class DescribeElasticsearchDomainResult extends Object implements Serializable

Serialized Fields

domainStatus

ElasticsearchDomainStatus domainStatus

The current status of the Elasticsearch domain.

Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainsRequest

class DescribeElasticsearchDomainsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

domainNames

List<String> domainNames

The Elasticsearch domains for which you want information.

Class com.amazonaws.services.elasticsearch.model.DescribeElasticsearchDomainsResult

class DescribeElasticsearchDomainsResult extends Object implements Serializable

Serialized Fields

domainStatusList

List<ElasticsearchDomainStatus> domainStatusList

The status of the domains requested in the DescribeElasticsearchDomains request.

Exception Class com.amazonaws.services.elasticsearch.model.DisabledOperationException

class DisabledOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticsearch.model.DomainInfo

class DomainInfo extends Object implements Serializable

Serialized Fields

domainName

String domainName

Specifies the DomainName.

Class com.amazonaws.services.elasticsearch.model.EBSOptions

class EBSOptions extends Object implements Serializable

Serialized Fields

eBSEnabled

Boolean eBSEnabled

Specifies whether EBS-based storage is enabled.

iops

Integer iops

Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

volumeSize

Integer volumeSize

Integer to specify the size of an EBS volume.

volumeType

String volumeType

Specifies the volume type for EBS-based storage.

Class com.amazonaws.services.elasticsearch.model.EBSOptionsStatus

class 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

class ElasticsearchClusterConfig extends Object implements Serializable

Serialized Fields

dedicatedMasterCount

Integer dedicatedMasterCount

Total number of dedicated master nodes, active and on standby, for the cluster.

dedicatedMasterEnabled

Boolean dedicatedMasterEnabled

A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

dedicatedMasterType

String dedicatedMasterType

The instance type for a dedicated master node.

instanceCount

Integer instanceCount

The number of instances in the specified domain cluster.

instanceType

String instanceType

The instance type for an Elasticsearch cluster.

zoneAwarenessEnabled

Boolean zoneAwarenessEnabled

A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

Class com.amazonaws.services.elasticsearch.model.ElasticsearchClusterConfigStatus

class 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

class ElasticsearchDomainConfig extends Object implements Serializable

Serialized Fields

accessPolicies

AccessPoliciesStatus accessPolicies

IAM access policy as a JSON-formatted string.

advancedOptions

AdvancedOptionsStatus advancedOptions

Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

eBSOptions

EBSOptionsStatus eBSOptions

Specifies the EBSOptions for the Elasticsearch domain.

elasticsearchClusterConfig

ElasticsearchClusterConfigStatus elasticsearchClusterConfig

Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

snapshotOptions

SnapshotOptionsStatus snapshotOptions

Specifies the SnapshotOptions for the Elasticsearch domain.

Class com.amazonaws.services.elasticsearch.model.ElasticsearchDomainStatus

class ElasticsearchDomainStatus extends Object implements Serializable

Serialized Fields

accessPolicies

String accessPolicies

IAM access policy as a JSON-formatted string.

advancedOptions

Map<String,String> advancedOptions

Specifies the status of the AdvancedOptions

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.

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

eBSOptions

EBSOptions eBSOptions

The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

elasticsearchClusterConfig

ElasticsearchClusterConfig elasticsearchClusterConfig

The type and number of instances in the domain cluster.

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.

snapshotOptions

SnapshotOptions snapshotOptions

Specifies the status of the SnapshotOptions

Exception Class com.amazonaws.services.elasticsearch.model.InternalException

class InternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticsearch.model.InvalidTypeException

class InvalidTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticsearch.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticsearch.model.ListDomainNamesRequest

class ListDomainNamesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.elasticsearch.model.ListDomainNamesResult

class ListDomainNamesResult extends Object implements Serializable

Serialized Fields

domainNames

List<DomainInfo> domainNames

List of Elasticsearch domain names.

Class com.amazonaws.services.elasticsearch.model.ListTagsRequest

class 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

class ListTagsResult extends Object implements Serializable

Serialized Fields

tagList

List<Tag> tagList

List of Tag for the requested Elasticsearch domain.

Class com.amazonaws.services.elasticsearch.model.OptionStatus

class OptionStatus extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

Timestamp which tells the creation date for the entity.

pendingDeletion

Boolean pendingDeletion

Indicates whether the Elasticsearch domain is being deleted.

state

String state

Provides the OptionState for the Elasticsearch domain.

updateDate

Date updateDate

Timestamp which tells the last updated time for the entity.

updateVersion

Integer updateVersion

Specifies the latest version for the entity.

Class com.amazonaws.services.elasticsearch.model.RemoveTagsRequest

class 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<String> tagKeys

Specifies the TagKey list which you want to remove from the Elasticsearch domain.

Class com.amazonaws.services.elasticsearch.model.RemoveTagsResult

class RemoveTagsResult extends Object implements Serializable

Exception Class com.amazonaws.services.elasticsearch.model.ResourceAlreadyExistsException

class ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elasticsearch.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elasticsearch.model.SnapshotOptions

class 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

class 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

class 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

class UpdateElasticsearchDomainConfigRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessPolicies

String accessPolicies

IAM access policy as a JSON-formatted string.

advancedOptions

Map<String,String> 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.

domainName

String domainName

The name of the Elasticsearch domain that you are updating.

eBSOptions

EBSOptions eBSOptions

Specify the type and size of the EBS volume that you want to use.

elasticsearchClusterConfig

ElasticsearchClusterConfig elasticsearchClusterConfig

The type and number of instances to instantiate for the domain cluster.

snapshotOptions

SnapshotOptions snapshotOptions

Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

Class com.amazonaws.services.elasticsearch.model.UpdateElasticsearchDomainConfigResult

class UpdateElasticsearchDomainConfigResult extends Object implements Serializable

Serialized Fields

domainConfig

ElasticsearchDomainConfig domainConfig

The status of the updated Elasticsearch domain.

Exception Class com.amazonaws.services.elasticsearch.model.ValidationException

class ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.elastictranscoder.model

Exception Class com.amazonaws.services.elastictranscoder.model.AccessDeniedException

class AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elastictranscoder.model.Artwork

class Artwork extends Object implements Serializable

Serialized Fields

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.

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.

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.

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.

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.

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.

Class com.amazonaws.services.elastictranscoder.model.AudioCodecOptions

class AudioCodecOptions extends Object implements Serializable

Serialized Fields

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.

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.

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

class AudioParameters extends Object implements Serializable

Serialized Fields

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

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.

codec

String codec

The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis.

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.

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.

Class com.amazonaws.services.elastictranscoder.model.CancelJobRequest

class 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

class CancelJobResult extends Object implements Serializable

Class com.amazonaws.services.elastictranscoder.model.CaptionFormat

class CaptionFormat extends Object implements Serializable

Serialized Fields

encryption

Encryption encryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption formats.

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.

Class com.amazonaws.services.elastictranscoder.model.Captions

class Captions extends Object implements Serializable

Serialized Fields

captionFormats

com.amazonaws.internal.SdkInternalList<CaptionFormat> captionFormats

The array of file formats for the output captions. If you leave this value blank, Elastic Transcoder returns an error.

captionSources

com.amazonaws.internal.SdkInternalList<CaptionSource> captionSources

Source files for the input sidecar captions used during the transcoding process. To omit all sidecar captions, leave CaptionSources blank.

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.

Class com.amazonaws.services.elastictranscoder.model.CaptionSource

class CaptionSource extends Object implements Serializable

Serialized Fields

encryption

Encryption encryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your caption sources.

key

String key

The name of the sidecar caption file that you want Elastic Transcoder to include in the output file.

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.

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.

Class com.amazonaws.services.elastictranscoder.model.Clip

class 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

class CreateJobOutput extends Object implements Serializable

Serialized Fields

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.

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.

composition

com.amazonaws.internal.SdkInternalList<Clip> 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.

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.

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.

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.

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.

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.

thumbnailEncryption

Encryption thumbnailEncryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

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.

watermarks

com.amazonaws.internal.SdkInternalList<JobWatermark> 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.

Class com.amazonaws.services.elastictranscoder.model.CreateJobPlaylist

class CreateJobPlaylist extends Object implements Serializable

Serialized Fields

format

String format

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

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.

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.

outputKeys

com.amazonaws.internal.SdkInternalList<String> 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.

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

class CreateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

input

JobInput input

A section of the request body that provides information about the file that is being transcoded.

output

CreateJobOutput output

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.

outputs

com.amazonaws.internal.SdkInternalList<CreateJobOutput> 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.

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.

playlists

com.amazonaws.internal.SdkInternalList<CreateJobPlaylist> 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<String,String> 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

class 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

class CreatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

inputBucket

String inputBucket

The Amazon S3 bucket in which you saved the media files that you want to transcode.

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.

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.

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.

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

class 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<Warning> 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

class CreatePresetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

audio

AudioParameters audio

A section of the request body that specifies the audio parameters.

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.

description

String description

A description of the preset.

name

String name

The name of the preset. We recommend that the name be unique within the AWS account, but uniqueness is not enforced.

thumbnails

Thumbnails thumbnails

A section of the request body that specifies the thumbnail parameters, if any.

video

VideoParameters video

A section of the request body that specifies the video parameters.

Class com.amazonaws.services.elastictranscoder.model.CreatePresetResult

class 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

class 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

class DeletePipelineResult extends Object implements Serializable

Class com.amazonaws.services.elastictranscoder.model.DeletePresetRequest

class 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

class DeletePresetResult extends Object implements Serializable

Class com.amazonaws.services.elastictranscoder.model.DetectedProperties

class DetectedProperties extends Object implements Serializable

Serialized Fields

durationMillis

Long durationMillis

The detected duration of the input file, in milliseconds.

fileSize

Long fileSize

The detected file size of the input file, in bytes.

frameRate

String frameRate

The detected frame rate of the input file, in frames per second.

height

Integer height

The detected height of the input file, in pixels.

width

Integer width

The detected width of the input file, in pixels.

Class com.amazonaws.services.elastictranscoder.model.Encryption

class Encryption extends Object implements Serializable

Serialized Fields

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.

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.

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.

Class com.amazonaws.services.elastictranscoder.model.HlsContentProtection

class HlsContentProtection extends Object implements Serializable

Serialized Fields

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.

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.

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.

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.

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.

Exception Class com.amazonaws.services.elastictranscoder.model.IncompatibleVersionException

class IncompatibleVersionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elastictranscoder.model.InternalServiceException

class InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elastictranscoder.model.Job

class Job extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN) for the job.

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.

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.

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.

outputs

com.amazonaws.internal.SdkInternalList<JobOutput> 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.

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.

playlists

com.amazonaws.internal.SdkInternalList<Playlist> 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.

timing

Timing timing

Details about the timing of a job.

userMetadata

com.amazonaws.internal.SdkInternalMap<String,String> 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: _.:/=+-%@

Class com.amazonaws.services.elastictranscoder.model.JobAlbumArt

class JobAlbumArt extends Object implements Serializable

Serialized Fields

artwork

com.amazonaws.internal.SdkInternalList<Artwork> 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

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.

Class com.amazonaws.services.elastictranscoder.model.JobInput

class JobInput extends Object implements Serializable

Serialized Fields

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.

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

detectedProperties

DetectedProperties detectedProperties

The detected properties of the input file.

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.

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.

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.

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.

resolution

String resolution

This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

Class com.amazonaws.services.elastictranscoder.model.JobOutput

class JobOutput extends Object implements Serializable

Serialized Fields

albumArt

JobAlbumArt albumArt

The album art to be associated with the output file, if any.

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.

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.

composition

com.amazonaws.internal.SdkInternalList<Clip> 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.

duration

Long duration

Duration of the output file, in seconds.

durationMillis

Long durationMillis

Duration of the output file, in milliseconds.

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.

fileSize

Long fileSize

File size of the output file, in bytes.

frameRate

String frameRate

Frame rate of the output file, in frames per second.

height

Integer height

Height of the output file, in pixels.

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.

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.

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.

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.

thumbnailEncryption

Encryption thumbnailEncryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your thumbnail.

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.

watermarks

com.amazonaws.internal.SdkInternalList<JobWatermark> 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.

width

Integer width

Specifies the width of the output file in pixels.

Class com.amazonaws.services.elastictranscoder.model.JobWatermark

class JobWatermark extends Object implements Serializable

Serialized Fields

encryption

Encryption encryption

The encryption settings, if any, that you want Elastic Transcoder to apply to your watermarks.

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.

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.

Exception Class com.amazonaws.services.elastictranscoder.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineRequest

class ListJobsByPipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

pipelineId

String pipelineId

The ID of the pipeline for which you want to get job information.

Class com.amazonaws.services.elastictranscoder.model.ListJobsByPipelineResult

class ListJobsByPipelineResult extends Object implements Serializable

Serialized Fields

jobs

com.amazonaws.internal.SdkInternalList<Job> 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

class ListJobsByStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.elastictranscoder.model.ListJobsByStatusResult

class ListJobsByStatusResult extends Object implements Serializable

Serialized Fields

jobs

com.amazonaws.internal.SdkInternalList<Job> 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

class 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

class ListPipelinesResult extends Object implements Serializable

Serialized Fields

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.

pipelines

com.amazonaws.internal.SdkInternalList<Pipeline> pipelines

An array of Pipeline objects.

Class com.amazonaws.services.elastictranscoder.model.ListPresetsRequest

class 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

class ListPresetsResult extends Object implements Serializable

Serialized Fields

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.

presets

com.amazonaws.internal.SdkInternalList<Preset> presets

An array of Preset objects.

Class com.amazonaws.services.elastictranscoder.model.Notifications

class Notifications extends Object implements Serializable

Serialized Fields

completed

String completed

The Amazon SNS topic that you want to notify when Elastic Transcoder has finished processing the job.

error

String error

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters an error condition.

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.

warning

String warning

The Amazon SNS topic that you want to notify when Elastic Transcoder encounters a warning condition.

Class com.amazonaws.services.elastictranscoder.model.Permission

class Permission extends Object implements Serializable

Serialized Fields

access

com.amazonaws.internal.SdkInternalList<String> 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.

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.

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.

Class com.amazonaws.services.elastictranscoder.model.Pipeline

class Pipeline extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN) for 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.

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.

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.

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.

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

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.

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.

status

String status

The current status of the pipeline:

• Active: The pipeline is processing jobs.
• Paused: The pipeline is not currently processing jobs.

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

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

permissions

com.amazonaws.internal.SdkInternalList<Permission> 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.

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.

Class com.amazonaws.services.elastictranscoder.model.Playlist

class Playlist extends Object implements Serializable

Serialized Fields

format

String format

The format of the output playlist. Valid formats include HLSv3, HLSv4, and Smooth.

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.

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.

outputKeys

com.amazonaws.internal.SdkInternalList<String> 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.

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

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

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.

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.

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.

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.

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

class Preset extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN) for the preset.

audio

AudioParameters audio

A section of the response body that provides information about the audio preset values.

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.

description

String description

A description of the preset.

id

String id

Identifier for the new preset. You use this value to get settings for the preset or to delete it.

name

String name

The name of the preset.

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

video

VideoParameters video

A section of the response body that provides information about the video preset values.

Class com.amazonaws.services.elastictranscoder.model.PresetWatermark

class PresetWatermark extends Object implements Serializable

Serialized Fields

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.

id

String id

A unique identifier for the settings for one watermark. The value of Id can be up to 40 characters long.

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.

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.

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.

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.

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.

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.

Class com.amazonaws.services.elastictranscoder.model.ReadJobRequest

class 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

class 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

class ReadPipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

id

String id

The identifier of the pipeline to read.

Class com.amazonaws.services.elastictranscoder.model.ReadPipelineResult

class 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<Warning> 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

class 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

class ReadPresetResult extends Object implements Serializable

Serialized Fields

preset

Preset preset

A section of the response body that provides information about the preset.

Exception Class com.amazonaws.services.elastictranscoder.model.ResourceInUseException

class ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.elastictranscoder.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elastictranscoder.model.TestRoleRequest

class TestRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

role

String role

The IAM Amazon Resource Name (ARN) for the role that you want Elastic Transcoder to test.

topics

com.amazonaws.internal.SdkInternalList<String> 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

class TestRoleResult extends Object implements Serializable

Serialized Fields

messages

com.amazonaws.internal.SdkInternalList<String> 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.

success

String success

If the operation is successful, this value is true; otherwise, the value is false.

Class com.amazonaws.services.elastictranscoder.model.Thumbnails

class Thumbnails extends Object implements Serializable

Serialized Fields

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.

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.

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.

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.

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.

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.

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.

Class com.amazonaws.services.elastictranscoder.model.TimeSpan

class TimeSpan extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.elastictranscoder.model.Timing

class Timing extends Object implements Serializable

Serialized Fields

finishTimeMillis

Long finishTimeMillis

The time the job finished transcoding, in epoch milliseconds.

startTimeMillis

Long startTimeMillis

The time the job began transcoding, in epoch milliseconds.

submitTimeMillis

Long submitTimeMillis

The time the job was submitted to Elastic Transcoder, in epoch milliseconds.

Class com.amazonaws.services.elastictranscoder.model.UpdatePipelineNotificationsRequest

class 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

class 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

class UpdatePipelineRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

id

String id

The ID of the pipeline that you want to update.

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.

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

notifications

Notifications notifications

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.

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

class UpdatePipelineResult extends Object implements Serializable

Serialized Fields

pipeline

Pipeline pipeline

warnings

com.amazonaws.internal.SdkInternalList<Warning> 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

class 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

class UpdatePipelineStatusResult extends Object implements Serializable

Serialized Fields

pipeline

Pipeline pipeline

A section of the response body that provides information about the pipeline.

Exception Class com.amazonaws.services.elastictranscoder.model.ValidationException

class ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.elastictranscoder.model.VideoParameters

class VideoParameters extends Object implements Serializable

Serialized Fields

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.

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

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<String,String> 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.

displayAspectRatio

String displayAspectRatio

The value that Elastic Transcoder adds to the metadata in the output file.

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.

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

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.

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.

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.

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.

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.

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

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.

watermarks

com.amazonaws.internal.SdkInternalList<PresetWatermark> 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

class 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

class Alias extends Object implements Serializable

Serialized Fields

aliasId

String aliasId

Unique identifier for a fleet alias.

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

description

String description

Human-readable description of the alias.

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

name

String name

Descriptive label associated with this alias. Alias names do not need to be unique.

routingStrategy

RoutingStrategy routingStrategy

Class com.amazonaws.services.gamelift.model.Build

class Build extends Object implements Serializable

Serialized Fields

buildId

String buildId

Unique identifier for a build.

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

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.

sizeOnDisk

Long sizeOnDisk

File size of the uploaded game build, expressed in bytes. When the build state is INITIALIZED, this value is 0.

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.

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.

Exception Class com.amazonaws.services.gamelift.model.ConflictException

class ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.gamelift.model.CreateAliasRequest

class CreateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

Human-readable description of the alias.

name

String name

Descriptive label associated with this alias. Alias names do not need to be unique.

routingStrategy

RoutingStrategy routingStrategy

Object specifying the fleet and routing type to use for the alias.

Class com.amazonaws.services.gamelift.model.CreateAliasResult

class CreateAliasResult extends Object implements Serializable

Serialized Fields

alias

Alias alias

Object containing the newly created alias record.

Class com.amazonaws.services.gamelift.model.CreateBuildRequest

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

storageLocation

S3Location storageLocation

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.

Class com.amazonaws.services.gamelift.model.CreateBuildResult

class CreateBuildResult extends Object implements Serializable

Serialized Fields

build

Build build

Set of properties for the newly created build.

storageLocation

S3Location storageLocation

Amazon S3 path and key, identifying where the game build files are stored.

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.

Class com.amazonaws.services.gamelift.model.CreateFleetRequest

class CreateFleetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

buildId

String buildId

Unique identifier for the build you want the new fleet to use.

description

String description

Human-readable description of the fleet.

eC2InboundPermissions

List<IpPermission> 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.

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.

logPaths

List<String> 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.

name

String name

Descriptive label associated with this fleet. Fleet names do not need to be unique.

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.

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

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.

Class com.amazonaws.services.gamelift.model.CreateFleetResult

class CreateFleetResult extends Object implements Serializable

Serialized Fields

fleetAttributes

FleetAttributes fleetAttributes

Properties for the newly created fleet.

Class com.amazonaws.services.gamelift.model.CreateGameSessionRequest

class CreateGameSessionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasId

String aliasId

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

fleetId

String fleetId

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

gameProperties

List<GameProperty> gameProperties

Set of properties used to administer a game session. These properties are passed to your game server.

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.

Class com.amazonaws.services.gamelift.model.CreateGameSessionResult

class 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

class 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

class 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

class CreatePlayerSessionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gameSessionId

String gameSessionId

Unique identifier for a game session.

playerIds

List<String> playerIds

List of unique identifiers for the players to be added.

Class com.amazonaws.services.gamelift.model.CreatePlayerSessionsResult

class CreatePlayerSessionsResult extends Object implements Serializable

Serialized Fields

playerSessions

List<PlayerSession> playerSessions

Collection of player session objects created for the added players.

Class com.amazonaws.services.gamelift.model.Credentials

class 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

class 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.DeleteAliasResult

class DeleteAliasResult extends Object implements Serializable

Class com.amazonaws.services.gamelift.model.DeleteBuildRequest

class 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.DeleteBuildResult

class DeleteBuildResult extends Object implements Serializable

Class com.amazonaws.services.gamelift.model.DeleteFleetRequest

class 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.DeleteFleetResult

class DeleteFleetResult extends Object implements Serializable

Class com.amazonaws.services.gamelift.model.DeleteScalingPolicyRequest

class DeleteScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for a fleet.

name

String name

Descriptive label associated with this scaling policy. Policy names do not need to be unique.

Class com.amazonaws.services.gamelift.model.DeleteScalingPolicyResult

class DeleteScalingPolicyResult extends Object implements Serializable

Class com.amazonaws.services.gamelift.model.DescribeAliasRequest

class 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

class DescribeAliasResult extends Object implements Serializable

Serialized Fields

alias

Alias alias

Object containing the requested alias.

Class com.amazonaws.services.gamelift.model.DescribeBuildRequest

class 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

class DescribeBuildResult extends Object implements Serializable

Serialized Fields

build

Build build

Set of properties describing the requested build.

Class com.amazonaws.services.gamelift.model.DescribeEC2InstanceLimitsRequest

class 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

class DescribeEC2InstanceLimitsResult extends Object implements Serializable

Serialized Fields

eC2InstanceLimits

List<EC2InstanceLimit> eC2InstanceLimits

Object containing the maximum number of instances for the specified instance type.

Class com.amazonaws.services.gamelift.model.DescribeFleetAttributesRequest

class DescribeFleetAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fleetIds

List<String> 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

class DescribeFleetAttributesResult extends Object implements Serializable

Serialized Fields

fleetAttributes

List<FleetAttributes> 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

class DescribeFleetCapacityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fleetIds

List<String> 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

class DescribeFleetCapacityResult extends Object implements Serializable

Serialized Fields

fleetCapacity

List<FleetCapacity> 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

class DescribeFleetEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

fleetId

String fleetId

Unique identifier for the fleet to get event logs 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.

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.

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

Class com.amazonaws.services.gamelift.model.DescribeFleetEventsResult

class DescribeFleetEventsResult extends Object implements Serializable

Serialized Fields

events

List<Event> 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

class 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

class DescribeFleetPortSettingsResult extends Object implements Serializable

Serialized Fields

inboundPermissions

List<IpPermission> inboundPermissions

Object containing port settings for the requested fleet ID.

Class com.amazonaws.services.gamelift.model.DescribeFleetUtilizationRequest

class DescribeFleetUtilizationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fleetIds

List<String> 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

class DescribeFleetUtilizationResult extends Object implements Serializable

Serialized Fields

fleetUtilization

List<FleetUtilization> 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

class DescribeGameSessionDetailsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasId

String aliasId

Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

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.

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.

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

Class com.amazonaws.services.gamelift.model.DescribeGameSessionDetailsResult

class DescribeGameSessionDetailsResult extends Object implements Serializable

Serialized Fields

gameSessionDetails

List<GameSessionDetail> 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

class DescribeGameSessionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasId

String aliasId

Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

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.

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.

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

Class com.amazonaws.services.gamelift.model.DescribeGameSessionsResult

class DescribeGameSessionsResult extends Object implements Serializable

Serialized Fields

gameSessions

List<GameSession> 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

class DescribePlayerSessionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

gameSessionId

String gameSessionId

Unique identifier for a game session.

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.

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

Class com.amazonaws.services.gamelift.model.DescribePlayerSessionsResult

class DescribePlayerSessionsResult extends Object implements Serializable

Serialized Fields

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.

playerSessions

List<PlayerSession> playerSessions

Collection of objects containing properties for each player session that matches the request.

Class com.amazonaws.services.gamelift.model.DescribeScalingPoliciesRequest

class DescribeScalingPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for a fleet. Specify the fleet to retrieve scaling policies 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.

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.

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.

Class com.amazonaws.services.gamelift.model.DescribeScalingPoliciesResult

class DescribeScalingPoliciesResult extends Object implements Serializable

Serialized Fields

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.

scalingPolicies

List<ScalingPolicy> scalingPolicies

Collection of objects containing the scaling policies matching the request.

Class com.amazonaws.services.gamelift.model.EC2InstanceCounts

class EC2InstanceCounts extends Object implements Serializable

Serialized Fields

aCTIVE

Integer aCTIVE

Actual number of active instances in the fleet.

dESIRED

Integer dESIRED

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

mAXIMUM

Integer mAXIMUM

Maximum value allowed for the fleet's instance count.

mINIMUM

Integer mINIMUM

Minimum value allowed for the fleet's instance count.

pENDING

Integer pENDING

Number of instances in the fleet that are starting but not yet active.

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

class EC2InstanceLimit extends Object implements Serializable

Serialized Fields

currentInstances

Integer currentInstances

Number of instances of the specified type that are currently in use by this AWS account.

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.

instanceLimit

Integer instanceLimit

Number of instances allowed.

Class com.amazonaws.services.gamelift.model.Event

class Event extends Object implements Serializable

Serialized Fields

eventCode

String eventCode

Type of event being logged.

eventId

String eventId

Unique identifier for a fleet 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).

message

String message

Additional information related to the event.

resourceId

String resourceId

Unique identifier for the resource, such as a fleet ID.

Class com.amazonaws.services.gamelift.model.FleetAttributes

class FleetAttributes extends Object implements Serializable

Serialized Fields

buildId

String buildId

Unique identifier for a build.

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

description

String description

Human-readable description of the fleet.

fleetId

String fleetId

Unique identifier for a fleet.

logPaths

List<String> 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.

name

String name

Descriptive label associated with this fleet. Fleet names do not need to be unique.

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.

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

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.

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.

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

Class com.amazonaws.services.gamelift.model.FleetCapacity

class FleetCapacity extends Object implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for a fleet.

instanceCounts

EC2InstanceCounts instanceCounts

Current status of fleet capacity.

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.

Exception Class com.amazonaws.services.gamelift.model.FleetCapacityExceededException

class FleetCapacityExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.gamelift.model.FleetUtilization

class FleetUtilization extends Object implements Serializable

Serialized Fields

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.

fleetId

String fleetId

Unique identifier for a fleet.

maximumPlayerSessionCount

Integer maximumPlayerSessionCount

Maximum players allowed across all game sessions currently hosted in the fleet.

Class com.amazonaws.services.gamelift.model.GameProperty

class GameProperty extends Object implements Serializable

Serialized Fields

key

String key

value

String value

Class com.amazonaws.services.gamelift.model.GameSession

class GameSession extends Object implements Serializable

Serialized Fields

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

currentPlayerSessionCount

Integer currentPlayerSessionCount

Number of players currently in the game session.

fleetId

String fleetId

Unique identifier for a fleet.

gameProperties

List<GameProperty> gameProperties

Set of custom properties for the game session.

gameSessionId

String gameSessionId

Unique identifier for a game session.

ipAddress

String ipAddress

IP address of the game session.

maximumPlayerSessionCount

Integer maximumPlayerSessionCount

Maximum number of players allowed in the game session.

name

String name

Descriptive label associated with this game session. Session names do not need to be unique.

playerSessionCreationPolicy

String playerSessionCreationPolicy

Indicates whether or not the game session is accepting new players.

status

String status

Current status of the game session. A game session must be in an ACTIVE state to have player sessions.

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

Class com.amazonaws.services.gamelift.model.GameSessionDetail

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

Exception Class com.amazonaws.services.gamelift.model.GameSessionFullException

class GameSessionFullException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.gamelift.model.GetGameSessionLogUrlRequest

class 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

class GetGameSessionLogUrlResult extends Object implements Serializable

Serialized Fields

preSignedUrl

String preSignedUrl

Location of the requested game session logs, available for download.

Exception Class com.amazonaws.services.gamelift.model.InternalServiceException

class InternalServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.gamelift.model.InvalidFleetStatusException

class InvalidFleetStatusException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.gamelift.model.InvalidGameSessionStatusException

class InvalidGameSessionStatusException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.gamelift.model.InvalidRequestException

class InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.gamelift.model.IpPermission

class IpPermission extends Object implements Serializable

Serialized Fields

fromPort

Integer fromPort

Starting value for a range of allowed port numbers.

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.

toPort

Integer toPort

Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

Exception Class com.amazonaws.services.gamelift.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.gamelift.model.ListAliasesRequest

class ListAliasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

name

String name

Descriptive label associated with this alias. Alias names do not need to be unique.

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.

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.

Class com.amazonaws.services.gamelift.model.ListAliasesResult

class ListAliasesResult extends Object implements Serializable

Serialized Fields

aliases

List<Alias> 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

class ListBuildsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.gamelift.model.ListBuildsResult

class ListBuildsResult extends Object implements Serializable

Serialized Fields

builds

List<Build> 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

class 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

class ListFleetsResult extends Object implements Serializable

Serialized Fields

fleetIds

List<String> 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.

Exception Class com.amazonaws.services.gamelift.model.NotFoundException

class NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.gamelift.model.PlayerSession

class PlayerSession extends Object implements Serializable

Serialized Fields

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

fleetId

String fleetId

Unique identifier for a fleet.

gameSessionId

String gameSessionId

Unique identifier for a game session.

ipAddress

String ipAddress

Game session IP address. All player sessions reference the game session location.

playerId

String playerId

Unique identifier for a player.

playerSessionId

String playerSessionId

Unique identifier for a player session.

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

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

Class com.amazonaws.services.gamelift.model.PutScalingPolicyRequest

class PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

fleetId

String fleetId

Unique identity for the fleet to scale with this policy.

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.

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.

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.

Class com.amazonaws.services.gamelift.model.PutScalingPolicyResult

class 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

class 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

class RequestUploadCredentialsResult extends Object implements Serializable

Serialized Fields

storageLocation

S3Location storageLocation

Amazon S3 path and key, identifying where the game build files are stored.

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.

Class com.amazonaws.services.gamelift.model.ResolveAliasRequest

class 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

class ResolveAliasResult extends Object implements Serializable

Serialized Fields

fleetId

String fleetId

Fleet ID associated with the requested alias.

Class com.amazonaws.services.gamelift.model.RoutingStrategy

class RoutingStrategy extends Object implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for a fleet.

message

String message

Message text to be used with a terminal routing strategy.

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.

Class com.amazonaws.services.gamelift.model.S3Location

class 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

class ScalingPolicy extends Object implements Serializable

Serialized Fields

comparisonOperator

String comparisonOperator

Comparison operator to use when measuring a 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.

fleetId

String fleetId

Unique identity for the fleet associated with this scaling policy.

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.

name

String name

Descriptive label associated with this scaling policy. Policy names do not need to be unique.

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.

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.

threshold

Double threshold

Metric value used to trigger a scaling event.

Exception Class com.amazonaws.services.gamelift.model.TerminalRoutingStrategyException

class TerminalRoutingStrategyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.gamelift.model.UnauthorizedException

class UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.gamelift.model.UpdateAliasRequest

class UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aliasId

String aliasId

Unique identifier for a fleet alias. Specify the alias you want to update.

description

String description

Human-readable description of the alias.

name

String name

Descriptive label associated with this alias. Alias names do not need to be unique.

routingStrategy

RoutingStrategy routingStrategy

Object specifying the fleet and routing type to use for the alias.

Class com.amazonaws.services.gamelift.model.UpdateAliasResult

class UpdateAliasResult extends Object implements Serializable

Serialized Fields

alias

Alias alias

Object containing the updated alias configuration.

Class com.amazonaws.services.gamelift.model.UpdateBuildRequest

class 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

class UpdateBuildResult extends Object implements Serializable

Serialized Fields

build

Build build

Object containing the updated build record.

Class com.amazonaws.services.gamelift.model.UpdateFleetAttributesRequest

class UpdateFleetAttributesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

Human-readable description of the fleet.

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.

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

class UpdateFleetAttributesResult extends Object implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for the updated fleet.

Class com.amazonaws.services.gamelift.model.UpdateFleetCapacityRequest

class UpdateFleetCapacityRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

desiredInstances

Integer desiredInstances

Number of EC2 instances you want this fleet to host.

fleetId

String fleetId

Unique identifier for the fleet you want to update capacity for.

maxSize

Integer maxSize

Maximum value allowed for the fleet's instance count. Default if not set is 1.

minSize

Integer minSize

Minimum value allowed for the fleet's instance count. Default if not set is 0.

Class com.amazonaws.services.gamelift.model.UpdateFleetCapacityResult

class UpdateFleetCapacityResult extends Object implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for the updated fleet.

Class com.amazonaws.services.gamelift.model.UpdateFleetPortSettingsRequest

class UpdateFleetPortSettingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for the fleet you want to update port settings for.

inboundPermissionAuthorizations

List<IpPermission> inboundPermissionAuthorizations

Collection of port settings to be added to the fleet record.

inboundPermissionRevocations

List<IpPermission> inboundPermissionRevocations

Collection of port settings to be removed from the fleet record.

Class com.amazonaws.services.gamelift.model.UpdateFleetPortSettingsResult

class UpdateFleetPortSettingsResult extends Object implements Serializable

Serialized Fields

fleetId

String fleetId

Unique identifier for the updated fleet.

Class com.amazonaws.services.gamelift.model.UpdateGameSessionRequest

class 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

class 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

class 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 apos-apos (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 (apos-apos) in the ID.

uploadId

String uploadId

The upload ID of the multipart upload to delete.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.AbortMultipartUploadResult

class AbortMultipartUploadResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.AbortVaultLockRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.AbortVaultLockResult

class AbortVaultLockResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.AddTagsToVaultRequest

class 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 apos-apos (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 (apos-apos) in the ID.

tags

Map<String,String> 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.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.AddTagsToVaultResult

class AddTagsToVaultResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.CompleteMultipartUploadRequest

class 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 apos-apos (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 (apos-apos) in the ID.

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.

uploadId

String uploadId

The upload ID of the multipart upload.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.CompleteMultipartUploadResult

class CompleteMultipartUploadResult extends Object implements Serializable

Serialized Fields

archiveId

String archiveId

The ID of the archive. This value is also included as part of the location.

checksum

String checksum

The checksum of the archive computed by Amazon Glacier.

location

String location

The relative URI path of the newly added archive resource.

Class com.amazonaws.services.glacier.model.CompleteVaultLockRequest

class 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 apos-apos (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 (apos-apos) in the ID.

lockId

String lockId

The lockId value is the lock ID obtained from a InitiateVaultLock request.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.CompleteVaultLockResult

class CompleteVaultLockResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.CreateVaultRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.CreateVaultResult

class 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

class DataRetrievalPolicy extends Object implements Serializable

Serialized Fields

rules

List<DataRetrievalRule> 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

class DataRetrievalRule extends Object implements Serializable

Serialized Fields

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.

strategy

String strategy

The type of data retrieval policy to set.

Valid values: BytesPerHour|FreeTier|None

Class com.amazonaws.services.glacier.model.DeleteArchiveRequest

class 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 apos-apos (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 (apos-apos) in the ID.

archiveId

String archiveId

The ID of the archive to delete.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DeleteArchiveResult

class DeleteArchiveResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.DeleteVaultAccessPolicyRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DeleteVaultAccessPolicyResult

class DeleteVaultAccessPolicyResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.DeleteVaultNotificationsRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DeleteVaultNotificationsResult

class DeleteVaultNotificationsResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.DeleteVaultRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DeleteVaultResult

class DeleteVaultResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.DescribeJobRequest

class 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 apos-apos (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 (apos-apos) in the ID.

jobId

String jobId

The ID of the job to describe.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DescribeJobResult

class DescribeJobResult extends Object implements Serializable

Serialized Fields

action

String action

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

archiveId

String archiveId

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

archiveSHA256TreeHash

String archiveSHA256TreeHash

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

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.

completed

Boolean completed

The job status. When a job is completed, you get the job's output.

completionDate

String completionDate

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

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

inventoryRetrievalParameters

InventoryRetrievalJobDescription inventoryRetrievalParameters

Parameters used for range inventory retrieval.

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.

jobDescription

String jobDescription

The job description you provided when you initiated the job.

jobId

String jobId

An opaque string that identifies an Amazon Glacier job.

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.

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.

sNSTopic

String sNSTopic

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

statusCode

String statusCode

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

statusMessage

String statusMessage

A friendly message that describes the job status.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

Class com.amazonaws.services.glacier.model.DescribeVaultOutput

class DescribeVaultOutput extends Object implements Serializable

Serialized Fields

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.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DescribeVaultRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.DescribeVaultResult

class DescribeVaultResult extends Object implements Serializable

Serialized Fields

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.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.GetDataRetrievalPolicyRequest

class 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 apos-apos (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 (apos-apos) in the ID.

Class com.amazonaws.services.glacier.model.GetDataRetrievalPolicyResult

class 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

class 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 apos-apos (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 (apos-apos) in the ID.

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.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.GetJobOutputResult

class GetJobOutputResult extends Object implements Serializable

Serialized Fields

acceptRanges

String acceptRanges

Indicates the range units accepted. For more information, go to RFC2616.

archiveDescription

String archiveDescription

The description of an archive.

body

InputStream body

The job data, either archive data or inventory data.

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.

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.

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.

status

Integer status

The HTTP response code for a job output request. The value depends on whether a range was specified in the request.

Class com.amazonaws.services.glacier.model.GetVaultAccessPolicyRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.GetVaultAccessPolicyResult

class 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

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.GetVaultLockResult

class GetVaultLockResult extends Object implements Serializable

Serialized Fields

creationDate

String creationDate

The UTC date and time at which the vault lock was put into the InProgress state.

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.

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.

Class com.amazonaws.services.glacier.model.GetVaultNotificationsRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.GetVaultNotificationsResult

class 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

class GlacierJobDescription extends Object implements Serializable

Serialized Fields

action

String action

The job type. It is either ArchiveRetrieval or InventoryRetrieval.

archiveId

String archiveId

For an ArchiveRetrieval job, this is the archive ID requested for download. Otherwise, this field is null.

archiveSHA256TreeHash

String archiveSHA256TreeHash

The SHA256 tree hash of the entire archive for an archive retrieval. For inventory retrieval jobs, this field is null.

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.

completed

Boolean completed

The job status. When a job is completed, you get the job's output.

completionDate

String completionDate

The UTC time that the archive retrieval request completed. While the job is in progress, the value will be null.

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

inventoryRetrievalParameters

InventoryRetrievalJobDescription inventoryRetrievalParameters

Parameters used for range inventory retrieval.

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.

jobDescription

String jobDescription

The job description you provided when you initiated the job.

jobId

String jobId

An opaque string that identifies an Amazon Glacier job.

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.

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.

sNSTopic

String sNSTopic

An Amazon Simple Notification Service (Amazon SNS) topic that receives notification.

statusCode

String statusCode

The status code can be InProgress, Succeeded, or Failed, and indicates the status of the job.

statusMessage

String statusMessage

A friendly message that describes the job status.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault from which the archive retrieval was requested.

Class com.amazonaws.services.glacier.model.InitiateJobRequest

class 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 apos-apos (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 (apos-apos) in the ID.

jobParameters

JobParameters jobParameters

Provides options for specifying job information.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.InitiateJobResult

class InitiateJobResult extends Object implements Serializable

Serialized Fields

jobId

String jobId

The ID of the job.

location

String location

The relative URI path of the job.

Class com.amazonaws.services.glacier.model.InitiateMultipartUploadRequest

class 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 apos-apos (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 (apos-apos) in the ID.

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.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.InitiateMultipartUploadResult

class 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

class 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 apos-apos (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 (apos-apos) in the ID.

policy

VaultLockPolicy policy

The vault lock policy as a JSON string, which uses "\" as an escape character.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.InitiateVaultLockResult

class InitiateVaultLockResult extends Object implements Serializable

Serialized Fields

lockId

String lockId

The lock ID, which is used to complete the vault locking process.

Exception Class com.amazonaws.services.glacier.model.InvalidParameterValueException

class InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

400 Bad Request

type

String type

Client

Class com.amazonaws.services.glacier.model.InventoryRetrievalJobDescription

class InventoryRetrievalJobDescription extends Object implements Serializable

Serialized Fields

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.

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

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.

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.

Class com.amazonaws.services.glacier.model.InventoryRetrievalJobInput

class InventoryRetrievalJobInput extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.glacier.model.JobParameters

class JobParameters extends Object implements Serializable

Serialized Fields

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.

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

inventoryRetrievalParameters

InventoryRetrievalJobInput inventoryRetrievalParameters

Input parameters used for range inventory retrieval.

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.

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.

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

Exception Class com.amazonaws.services.glacier.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

400 Bad Request

type

String type

Client

Class com.amazonaws.services.glacier.model.ListJobsRequest

class 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 apos-apos (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 (apos-apos) in the ID.

completed

String completed

Specifies the state of the jobs to return. You can specify true or false.

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

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.ListJobsResult

class ListJobsResult extends Object implements Serializable

Serialized Fields

jobList

List<GlacierJobDescription> 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

class 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 apos-apos (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 (apos-apos) in the ID.

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.

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.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.ListMultipartUploadsResult

class ListMultipartUploadsResult extends Object implements Serializable

Serialized Fields

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.

uploadsList

List<UploadListElement> uploadsList

A list of in-progress multipart uploads.

Class com.amazonaws.services.glacier.model.ListPartsRequest

class 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 apos-apos (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 (apos-apos) in the ID.

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.

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.

uploadId

String uploadId

The upload ID of the multipart upload.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.ListPartsResult

class ListPartsResult extends Object implements Serializable

Serialized Fields

archiveDescription

String archiveDescription

The description of the archive that was specified in the Initiate Multipart Upload request.

creationDate

String creationDate

The UTC time at which the multipart upload was initiated.

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.

multipartUploadId

String multipartUploadId

The ID of the upload to which the parts are associated.

parts

List<PartListElement> parts

A list of the part sizes of the multipart upload.

partSizeInBytes

Long partSizeInBytes

The part size in bytes.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault to which the multipart upload was initiated.

Class com.amazonaws.services.glacier.model.ListTagsForVaultRequest

class 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 apos-apos (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 (apos-apos) in the ID.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.ListTagsForVaultResult

class ListTagsForVaultResult extends Object implements Serializable

Serialized Fields

tags

Map<String,String> tags

The tags attached to the vault. Each tag is composed of a key and a value.

Class com.amazonaws.services.glacier.model.ListVaultsRequest

class 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 apos-apos (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 (apos-apos) in the ID.

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.

marker

String marker

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Class com.amazonaws.services.glacier.model.ListVaultsResult

class ListVaultsResult extends Object implements Serializable

Serialized Fields

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.

vaultList

List<DescribeVaultOutput> vaultList

List of vaults.

Exception Class com.amazonaws.services.glacier.model.MissingParameterValueException

class MissingParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

400 Bad Request

type

String type

Client.

Class com.amazonaws.services.glacier.model.PartListElement

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

Exception Class com.amazonaws.services.glacier.model.PolicyEnforcedException

class PolicyEnforcedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

PolicyEnforcedException

type

String type

Client

Class com.amazonaws.services.glacier.model.RemoveTagsFromVaultRequest

class 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 apos-apos (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 (apos-apos) in the ID.

tagKeys

List<String> tagKeys

A list of tag keys. Each corresponding tag is removed from the vault.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.RemoveTagsFromVaultResult

class RemoveTagsFromVaultResult extends Object implements Serializable

Exception Class com.amazonaws.services.glacier.model.RequestTimeoutException

class RequestTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

408 Request Timeout

type

String type

Client

Exception Class com.amazonaws.services.glacier.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

404 Not Found

type

String type

Client

Exception Class com.amazonaws.services.glacier.model.ServiceUnavailableException

class ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

String code

500 Internal Server Error

type

String type

Server

Class com.amazonaws.services.glacier.model.SetDataRetrievalPolicyRequest

class 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 apos-apos (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 (apos-apos) in the ID.

policy

DataRetrievalPolicy policy

The data retrieval policy in JSON format.

Class com.amazonaws.services.glacier.model.SetDataRetrievalPolicyResult

class SetDataRetrievalPolicyResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.SetVaultAccessPolicyRequest

class 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 apos-apos (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 (apos-apos) in the ID.

policy

VaultAccessPolicy policy

The vault access policy as a JSON string.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.SetVaultAccessPolicyResult

class SetVaultAccessPolicyResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.SetVaultNotificationsRequest

class 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 apos-apos (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 (apos-apos) 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.SetVaultNotificationsResult

class SetVaultNotificationsResult extends Object implements Serializable

Class com.amazonaws.services.glacier.model.UploadArchiveRequest

class UploadArchiveRequest 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 apos-apos (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 (apos-apos) in the ID.

archiveDescription

String archiveDescription

The optional description of the archive you are uploading.

body

InputStream body

The data to upload.

checksum

String checksum

The SHA256 tree hash of the data being uploaded.

contentLength

Long contentLength

The content length of the archive to upload.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.UploadArchiveResult

class UploadArchiveResult extends Object implements Serializable

Serialized Fields

archiveId

String archiveId

The ID of the archive. This value is also included as part of the location.

checksum

String checksum

The checksum of the archive computed by Amazon Glacier.

location

String location

The relative URI path of the newly added archive resource.

Class com.amazonaws.services.glacier.model.UploadListElement

class UploadListElement extends Object implements Serializable

Serialized Fields

archiveDescription

String archiveDescription

The description of the archive that was specified in the Initiate Multipart Upload request.

creationDate

String creationDate

The UTC time at which the multipart upload was initiated.

multipartUploadId

String multipartUploadId

The ID of a multipart upload.

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.

vaultARN

String vaultARN

The Amazon Resource Name (ARN) of the vault that contains the archive.

Class com.amazonaws.services.glacier.model.UploadMultipartPartRequest

class 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 apos-apos (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 (apos-apos) in the ID.

body

InputStream body

The data to 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/*.

uploadId

String uploadId

The upload ID of the multipart upload.

vaultName

String vaultName

The name of the vault.

Class com.amazonaws.services.glacier.model.UploadMultipartPartResult

class 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

class VaultAccessPolicy extends Object implements Serializable

Serialized Fields

policy

String policy

The vault access policy.

Class com.amazonaws.services.glacier.model.VaultLockPolicy

class VaultLockPolicy extends Object implements Serializable

Serialized Fields

policy

String policy

The vault lock policy.

Class com.amazonaws.services.glacier.model.VaultNotificationConfig

class VaultNotificationConfig extends Object implements Serializable

Serialized Fields

events

List<String> events

A list of one or more events for which Amazon Glacier will send a notification to the specified Amazon SNS topic.

sNSTopic

String sNSTopic

The Amazon Simple Notification Service (Amazon SNS) topic Amazon Resource Name (ARN).

Package com.amazonaws.services.identitymanagement.model

Class com.amazonaws.services.identitymanagement.model.AccessKey

class AccessKey extends Object implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

The ID for this access key.

createDate

Date createDate

The date when the access key was created.

secretAccessKey

String secretAccessKey

The secret key used to sign requests.

status

String status

The status of the access key. Active means the key is valid for API calls, while Inactive means it is not.

userName

String userName

The name of the IAM user that the access key is associated with.

Class com.amazonaws.services.identitymanagement.model.AccessKeyLastUsed

class 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

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.

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

Class com.amazonaws.services.identitymanagement.model.AccessKeyMetadata

class AccessKeyMetadata extends Object implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

The ID for this access key.

createDate

Date createDate

The date when the access key was created.

status

String status

The status of the access key. Active means the key is valid for API calls; Inactive means it is not.

userName

String userName

The name of the IAM user that the key is associated with.

Class com.amazonaws.services.identitymanagement.model.AddClientIDToOpenIDConnectProviderRequest

class AddClientIDToOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientID

String clientID

The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.

openIDConnectProviderArn

String openIDConnectProviderArn

The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.

Class com.amazonaws.services.identitymanagement.model.AddClientIDToOpenIDConnectProviderResult

class AddClientIDToOpenIDConnectProviderResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.AddRoleToInstanceProfileRequest

class AddRoleToInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

The name of the instance profile to update.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

roleName

String roleName

The name of the role to add.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.AddRoleToInstanceProfileResult

class AddRoleToInstanceProfileResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.AddUserToGroupRequest

class AddUserToGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group to update.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

userName

String userName

The name of the user to add.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.AddUserToGroupResult

class AddUserToGroupResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.AttachedPolicy

class AttachedPolicy extends Object implements Serializable

Serialized Fields

policyArn

String policyArn

policyName

String policyName

The friendly name of the attached policy.

Class com.amazonaws.services.identitymanagement.model.AttachGroupPolicyRequest

class AttachGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name (friendly name, not ARN) of the group to attach the policy to.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.AttachGroupPolicyResult

class AttachGroupPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.AttachRolePolicyRequest

class AttachRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

roleName

String roleName

The name (friendly name, not ARN) of the role to attach the policy to.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.AttachRolePolicyResult

class AttachRolePolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.AttachUserPolicyRequest

class AttachUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy you want to attach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

userName

String userName

The name (friendly name, not ARN) of the IAM user to attach the policy to.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.AttachUserPolicyResult

class AttachUserPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.ChangePasswordRequest

class ChangePasswordRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

newPassword

String newPassword

The new password. The new password must conform to the AWS account's password policy, if one exists.

The regex pattern for this parameter is a string of characters consisting of almost any printable ASCII character from the space ( ) through the end of the ASCII character range (ÿ). You can also include the tab ( ), line feed ( ), and carriage return ( ) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.

oldPassword

String oldPassword

The IAM user's current password.

Class com.amazonaws.services.identitymanagement.model.ChangePasswordResult

class ChangePasswordResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.ContextEntry

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

contextKeyType

String contextKeyType

The data type of the value (or values) specified in the ContextKeyValues parameter.

contextKeyValues

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.identitymanagement.model.CreateAccessKeyRequest

class CreateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The name of the IAM user that the new key will belong to.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.CreateAccessKeyResult

class CreateAccessKeyResult extends Object implements Serializable

Serialized Fields

accessKey

AccessKey accessKey

A structure with details about the access key.

Class com.amazonaws.services.identitymanagement.model.CreateAccountAliasRequest

class CreateAccountAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountAlias

String accountAlias

The account alias to create.

The regex pattern for this parameter is a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

Class com.amazonaws.services.identitymanagement.model.CreateAccountAliasResult

class CreateAccountAliasResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.CreateGroupRequest

class CreateGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group to create. Do not include the path in this value.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

path

String path

The path to the group. 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 (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.CreateGroupResult

class CreateGroupResult extends Object implements Serializable

Serialized Fields

group

Group group

A structure containing details about the new group.

Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileRequest

class CreateInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

The name of the instance profile to create.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

path

String path

The path to the instance profile. 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 (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.CreateInstanceProfileResult

class CreateInstanceProfileResult extends Object implements Serializable

Serialized Fields

instanceProfile

InstanceProfile instanceProfile

A structure containing details about the new instance profile.

Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileRequest

class CreateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

password

String password

The new password for the user.

The regex pattern for this parameter is a string of characters consisting of almost any printable ASCII character from the space ( ) through the end of the ASCII character range (ÿ). You can also include the tab ( ), line feed ( ), and carriage return ( ) characters. Although any of these characters are valid in a password, note that many tools, such as the AWS Management Console, might restrict the ability to enter certain characters because they have special meaning within that tool.

passwordResetRequired

Boolean passwordResetRequired

Specifies whether the user is required to set a new password on next sign-in.

userName

String userName

The name of the IAM user to create a password for. The user must already exist.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.CreateLoginProfileResult

class CreateLoginProfileResult extends Object implements Serializable

Serialized Fields

loginProfile

LoginProfile loginProfile

A structure containing the user name and password create date.

Class com.amazonaws.services.identitymanagement.model.CreateOpenIDConnectProviderRequest

class CreateOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientIDList

com.amazonaws.internal.SdkInternalList<String> 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<String> 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.

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.

Class com.amazonaws.services.identitymanagement.model.CreateOpenIDConnectProviderResult

class CreateOpenIDConnectProviderResult extends Object implements Serializable

Serialized Fields

openIDConnectProviderArn

String openIDConnectProviderArn

The Amazon Resource Name (ARN) of the new IAM OpenID Connect provider that is created. For more information, see OpenIDConnectProviderListEntry.

Class com.amazonaws.services.identitymanagement.model.CreatePolicyRequest

class CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

policyDocument

String policyDocument

The JSON policy document that you want to use as the content for the new policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

policyName

String policyName

The friendly name of the policy.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.CreatePolicyResult

class CreatePolicyResult extends Object implements Serializable

Serialized Fields

policy

Policy policy

A structure containing details about the new policy.

Class com.amazonaws.services.identitymanagement.model.CreatePolicyVersionRequest

class CreatePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy to which you want to add a new version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

policyDocument

String policyDocument

The JSON policy document that you want to use as the content for this new version of the policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

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

class CreatePolicyVersionResult extends Object implements Serializable

Serialized Fields

policyVersion

PolicyVersion policyVersion

A structure containing details about the new policy version.

Class com.amazonaws.services.identitymanagement.model.CreateRoleRequest

class CreateRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assumeRolePolicyDocument

String assumeRolePolicyDocument

The trust relationship policy document that grants an entity permission to assume the role.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

path

String path

The path to the role. 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 (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

roleName

String roleName

The name of the role to create.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.CreateRoleResult

class CreateRoleResult extends Object implements Serializable

Serialized Fields

role

Role role

A structure containing details about the new role.

Class com.amazonaws.services.identitymanagement.model.CreateSAMLProviderRequest

class CreateSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

The name of the provider to create.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

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

Class com.amazonaws.services.identitymanagement.model.CreateSAMLProviderResult

class CreateSAMLProviderResult extends Object implements Serializable

Serialized Fields

sAMLProviderArn

String sAMLProviderArn

The Amazon Resource Name (ARN) of the new SAML provider resource in IAM.

Class com.amazonaws.services.identitymanagement.model.CreateUserRequest

class 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 IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

userName

String userName

The name of the user to create.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.CreateUserResult

class CreateUserResult extends Object implements Serializable

Serialized Fields

user

User user

A structure with details about the new IAM user.

Class com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceRequest

class 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 IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/).

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

virtualMFADeviceName

String virtualMFADeviceName

The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.CreateVirtualMFADeviceResult

class CreateVirtualMFADeviceResult extends Object implements Serializable

Serialized Fields

virtualMFADevice

VirtualMFADevice virtualMFADevice

A structure containing details about the new virtual MFA device.

Exception Class com.amazonaws.services.identitymanagement.model.CredentialReportExpiredException

class CredentialReportExpiredException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.CredentialReportNotPresentException

class CredentialReportNotPresentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.CredentialReportNotReadyException

class CredentialReportNotReadyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.DeactivateMFADeviceRequest

class DeactivateMFADeviceRequest 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 device ARN.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-

userName

String userName

The name of the user whose MFA device you want to deactivate.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeactivateMFADeviceResult

class DeactivateMFADeviceResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteAccessKeyRequest

class DeleteAccessKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

The access key ID for the access key ID and secret access key you want to delete.

The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

userName

String userName

The name of the user whose access key pair you want to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteAccessKeyResult

class DeleteAccessKeyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteAccountAliasRequest

class DeleteAccountAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accountAlias

String accountAlias

The name of the account alias to delete.

The regex pattern for this parameter is a string of characters consisting of lowercase letters, digits, and dashes. You cannot start or finish with a dash, nor can you have two dashes in a row.

Class com.amazonaws.services.identitymanagement.model.DeleteAccountAliasResult

class DeleteAccountAliasResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteAccountPasswordPolicyRequest

class DeleteAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteAccountPasswordPolicyResult

class DeleteAccountPasswordPolicyResult extends Object implements Serializable

Exception Class com.amazonaws.services.identitymanagement.model.DeleteConflictException

class DeleteConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.DeleteGroupPolicyRequest

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

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

policyName

String policyName

The name identifying the policy document to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteGroupPolicyResult

class DeleteGroupPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteGroupRequest

class DeleteGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the IAM group to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteGroupResult

class DeleteGroupResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteInstanceProfileRequest

class DeleteInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

The name of the instance profile to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteInstanceProfileResult

class DeleteInstanceProfileResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteLoginProfileRequest

class DeleteLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The name of the user whose password you want to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteLoginProfileResult

class DeleteLoginProfileResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteOpenIDConnectProviderRequest

class DeleteOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

openIDConnectProviderArn

String openIDConnectProviderArn

The Amazon Resource Name (ARN) of the IAM OpenID Connect provider resource object to delete. You can get a list of OpenID Connect provider resource ARNs by using the ListOpenIDConnectProviders action.

Class com.amazonaws.services.identitymanagement.model.DeleteOpenIDConnectProviderResult

class DeleteOpenIDConnectProviderResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeletePolicyRequest

class DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy you want to delete.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.DeletePolicyResult

class DeletePolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeletePolicyVersionRequest

class DeletePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy from which you want to delete a version.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

versionId

String versionId

The policy version to delete.

The regex pattern for this parameter is a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Class com.amazonaws.services.identitymanagement.model.DeletePolicyVersionResult

class DeletePolicyVersionResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteRolePolicyRequest

class DeleteRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the inline policy to delete from the specified IAM role.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

roleName

String roleName

The name (friendly name, not ARN) identifying the role that the policy is embedded in.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteRolePolicyResult

class DeleteRolePolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteRoleRequest

class DeleteRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

The name of the role to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteRoleResult

class DeleteRoleResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteSAMLProviderRequest

class 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.DeleteSAMLProviderResult

class DeleteSAMLProviderResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteServerCertificateRequest

class DeleteServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverCertificateName

String serverCertificateName

The name of the server certificate you want to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteServerCertificateResult

class DeleteServerCertificateResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteSigningCertificateRequest

class DeleteSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the signing certificate to delete.

The format of this parameter, as described by its regex pattern, is a string of characters that can be upper- or lower-cased letters or digits.

userName

String userName

The name of the user the signing certificate belongs to.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteSigningCertificateResult

class DeleteSigningCertificateResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteSSHPublicKeyRequest

class DeleteSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sSHPublicKeyId

String sSHPublicKeyId

The unique identifier for the SSH public key.

The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

userName

String userName

The name of the IAM user associated with the SSH public key.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteSSHPublicKeyResult

class DeleteSSHPublicKeyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteUserPolicyRequest

class DeleteUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name identifying the policy document to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

userName

String userName

The name (friendly name, not ARN) identifying the user that the policy is embedded in.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteUserPolicyResult

class DeleteUserPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteUserRequest

class DeleteUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The name of the user to delete.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteUserResult

class DeleteUserResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DeleteVirtualMFADeviceRequest

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

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-

Class com.amazonaws.services.identitymanagement.model.DeleteVirtualMFADeviceResult

class DeleteVirtualMFADeviceResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DetachGroupPolicyRequest

class DetachGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name (friendly name, not ARN) of the IAM group to detach the policy from.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.DetachGroupPolicyResult

class DetachGroupPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DetachRolePolicyRequest

class DetachRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

roleName

String roleName

The name (friendly name, not ARN) of the IAM role to detach the policy from.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DetachRolePolicyResult

class DetachRolePolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.DetachUserPolicyRequest

class DetachUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy you want to detach.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

userName

String userName

The name (friendly name, not ARN) of the IAM user to detach the policy from.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.DetachUserPolicyResult

class DetachUserPolicyResult extends Object implements Serializable

Exception Class com.amazonaws.services.identitymanagement.model.DuplicateCertificateException

class DuplicateCertificateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.DuplicateSSHPublicKeyException

class DuplicateSSHPublicKeyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.EnableMFADeviceRequest

class EnableMFADeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authenticationCode1

String authenticationCode1

An authentication code emitted by the device.

The format for this parameter is a string of 6 digits.

authenticationCode2

String authenticationCode2

A subsequent authentication code emitted by the device.

The format for this parameter is a string of 6 digits.

serialNumber

String serialNumber

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =/:,.@-

userName

String userName

The name of the IAM user for whom you want to enable the MFA device.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.EnableMFADeviceResult

class EnableMFADeviceResult extends Object implements Serializable

Exception Class com.amazonaws.services.identitymanagement.model.EntityAlreadyExistsException

class EntityAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.EntityTemporarilyUnmodifiableException

class EntityTemporarilyUnmodifiableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.EvaluationResult

class EvaluationResult extends Object implements Serializable

Serialized Fields

evalActionName

String evalActionName

The name of the API action tested on the indicated resource.

evalDecision

String evalDecision

The result of the simulation.

evalDecisionDetails

com.amazonaws.internal.SdkInternalMap<String,String> 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

evalResourceName

String evalResourceName

The ARN of the resource that the indicated API action was tested on.

matchedStatements

com.amazonaws.internal.SdkInternalList<Statement> 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<String> 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. This list is used when the resource in a simulation is "*", either explicitly, or when the ResourceArns parameter blank. If you include a list of resources, then any missing context values are instead included under the ResourceSpecificResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

resourceSpecificResults

com.amazonaws.internal.SdkInternalList<ResourceSpecificResult> resourceSpecificResults

The individual results of the simulation of the API action specified in EvalActionName on each resource.

Class com.amazonaws.services.identitymanagement.model.GenerateCredentialReportRequest

class GenerateCredentialReportRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.GenerateCredentialReportResult

class GenerateCredentialReportResult extends Object implements Serializable

Serialized Fields

description

String description

Information about the credential report.

state

String state

Information about the state of the credential report.

Class com.amazonaws.services.identitymanagement.model.GetAccessKeyLastUsedRequest

class GetAccessKeyLastUsedRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

The identifier of an access key.

The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

Class com.amazonaws.services.identitymanagement.model.GetAccessKeyLastUsedResult

class GetAccessKeyLastUsedResult extends Object implements Serializable

Serialized Fields

accessKeyLastUsed

AccessKeyLastUsed accessKeyLastUsed

Contains information about the last time the access key was used.

userName

String userName

The name of the AWS IAM user that owns this access key.

Class com.amazonaws.services.identitymanagement.model.GetAccountAuthorizationDetailsRequest

class GetAccountAuthorizationDetailsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filter

com.amazonaws.internal.SdkInternalList<String> filter

A list of entity types (user, group, role, local managed policy, or AWS managed policy) for filtering the results.

The format for this parameter is a comma-separated (if more than one) list of strings. Each string value in the list must be one of the valid values listed below.

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

class GetAccountAuthorizationDetailsResult extends Object implements Serializable

Serialized Fields

groupDetailList

com.amazonaws.internal.SdkInternalList<GroupDetail> groupDetailList

A list containing information about IAM 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.

policies

com.amazonaws.internal.SdkInternalList<ManagedPolicyDetail> policies

A list containing information about managed policies.

roleDetailList

com.amazonaws.internal.SdkInternalList<RoleDetail> roleDetailList

A list containing information about IAM roles.

userDetailList

com.amazonaws.internal.SdkInternalList<UserDetail> userDetailList

A list containing information about IAM users.

Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyRequest

class GetAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.GetAccountPasswordPolicyResult

class GetAccountPasswordPolicyResult extends Object implements Serializable

Serialized Fields

passwordPolicy

PasswordPolicy passwordPolicy

Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryRequest

class GetAccountSummaryRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.GetAccountSummaryResult

class GetAccountSummaryResult extends Object implements Serializable

Serialized Fields

summaryMap

com.amazonaws.internal.SdkInternalMap<String,Integer> summaryMap

A set of key value pairs containing information about IAM entity usage and IAM quotas.

Class com.amazonaws.services.identitymanagement.model.GetContextKeysForCustomPolicyRequest

class GetContextKeysForCustomPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyInputList

com.amazonaws.internal.SdkInternalList<String> policyInputList

A list of policies for which you want the list of context keys referenced in those policies. Each document is specified as a string containing the complete, valid JSON text of an IAM policy.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Class com.amazonaws.services.identitymanagement.model.GetContextKeysForCustomPolicyResult

class GetContextKeysForCustomPolicyResult extends Object implements Serializable

Serialized Fields

contextKeyNames

com.amazonaws.internal.SdkInternalList<String> contextKeyNames

The list of context keys that are referenced in the input policies.

Class com.amazonaws.services.identitymanagement.model.GetContextKeysForPrincipalPolicyRequest

class GetContextKeysForPrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyInputList

com.amazonaws.internal.SdkInternalList<String> policyInputList

An optional list of additional policies for which you want the list of context keys that are referenced.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

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.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.GetContextKeysForPrincipalPolicyResult

class GetContextKeysForPrincipalPolicyResult extends Object implements Serializable

Serialized Fields

contextKeyNames

com.amazonaws.internal.SdkInternalList<String> contextKeyNames

The list of context keys that are referenced in the input policies.

Class com.amazonaws.services.identitymanagement.model.GetCredentialReportRequest

class GetCredentialReportRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.GetCredentialReportResult

class GetCredentialReportResult extends Object implements Serializable

Serialized Fields

content

ByteBuffer content

Contains the credential report. The report is Base64-encoded.

generatedTime

Date generatedTime

The date and time when the credential report was created, in ISO 8601 date-time format.

reportFormat

String reportFormat

The format (MIME type) of the credential report.

Class com.amazonaws.services.identitymanagement.model.GetGroupPolicyRequest

class GetGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group the policy is associated with.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

policyName

String policyName

The name of the policy document to get.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetGroupPolicyResult

class GetGroupPolicyResult extends Object implements Serializable

Serialized Fields

groupName

String groupName

The group the policy is associated with.

policyDocument

String policyDocument

The policy document.

policyName

String policyName

The name of the policy.

Class com.amazonaws.services.identitymanagement.model.GetGroupRequest

class GetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

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

class GetGroupResult extends Object implements Serializable

Serialized Fields

group

Group group

A structure that contains details about 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.

users

com.amazonaws.internal.SdkInternalList<User> users

A list of users in the group.

Class com.amazonaws.services.identitymanagement.model.GetInstanceProfileRequest

class GetInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

The name of the instance profile to get information about.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetInstanceProfileResult

class GetInstanceProfileResult extends Object implements Serializable

Serialized Fields

instanceProfile

InstanceProfile instanceProfile

A structure containing details about the instance profile.

Class com.amazonaws.services.identitymanagement.model.GetLoginProfileRequest

class GetLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

userName

String userName

The name of the user whose login profile you want to retrieve.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetLoginProfileResult

class GetLoginProfileResult extends Object implements Serializable

Serialized Fields

loginProfile

LoginProfile loginProfile

A structure containing the user name and password create date for the user.

Class com.amazonaws.services.identitymanagement.model.GetOpenIDConnectProviderRequest

class GetOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

openIDConnectProviderArn

String openIDConnectProviderArn

The Amazon Resource Name (ARN) of the OIDC provider resource object in IAM to get information for. You can get a list of OIDC provider resource ARNs by using the ListOpenIDConnectProviders action.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.GetOpenIDConnectProviderResult

class GetOpenIDConnectProviderResult extends Object implements Serializable

Serialized Fields

clientIDList

com.amazonaws.internal.SdkInternalList<String> clientIDList

A list of client IDs (also known as audiences) that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

createDate

Date createDate

The date and time when the IAM OIDC provider resource object was created in the AWS account.

thumbprintList

com.amazonaws.internal.SdkInternalList<String> thumbprintList

A list of certificate thumbprints that are associated with the specified IAM OIDC provider resource object. For more information, see CreateOpenIDConnectProvider.

url

String url

The URL that the IAM OIDC provider resource object is associated with. For more information, see CreateOpenIDConnectProvider.

Class com.amazonaws.services.identitymanagement.model.GetPolicyRequest

class GetPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.GetPolicyResult

class GetPolicyResult extends Object implements Serializable

Serialized Fields

policy

Policy policy

A structure containing details about the policy.

Class com.amazonaws.services.identitymanagement.model.GetPolicyVersionRequest

class GetPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the managed policy that you want information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

versionId

String versionId

Identifies the policy version to retrieve.

The regex pattern for this parameter is a string of characters that consists of the lowercase letter 'v' followed by one or two digits, and optionally followed by a period '.' and a string of letters and digits.

Class com.amazonaws.services.identitymanagement.model.GetPolicyVersionResult

class GetPolicyVersionResult extends Object implements Serializable

Serialized Fields

policyVersion

PolicyVersion policyVersion

A structure containing details about the policy version.

Class com.amazonaws.services.identitymanagement.model.GetRolePolicyRequest

class GetRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the policy document to get.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

roleName

String roleName

The name of the role associated with the policy.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetRolePolicyResult

class GetRolePolicyResult extends Object implements Serializable

Serialized Fields

policyDocument

String policyDocument

The policy document.

policyName

String policyName

The name of the policy.

roleName

String roleName

The role the policy is associated with.

Class com.amazonaws.services.identitymanagement.model.GetRoleRequest

class GetRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleName

String roleName

The name of the IAM role to get information about.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetRoleResult

class GetRoleResult extends Object implements Serializable

Serialized Fields

role

Role role

A structure containing details about the IAM role.

Class com.amazonaws.services.identitymanagement.model.GetSAMLProviderRequest

class GetSAMLProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sAMLProviderArn

String sAMLProviderArn

The Amazon Resource Name (ARN) of the SAML provider resource object in IAM to get information about.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.GetSAMLProviderResult

class GetSAMLProviderResult extends Object implements Serializable

Serialized Fields

createDate

Date createDate

The date and time when the SAML provider was created.

sAMLMetadataDocument

String sAMLMetadataDocument

The XML metadata document that includes information about an identity provider.

validUntil

Date validUntil

The expiration date and time for the SAML provider.

Class com.amazonaws.services.identitymanagement.model.GetServerCertificateRequest

class GetServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serverCertificateName

String serverCertificateName

The name of the server certificate you want to retrieve information about.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetServerCertificateResult

class GetServerCertificateResult extends Object implements Serializable

Serialized Fields

serverCertificate

ServerCertificate serverCertificate

A structure containing details about the server certificate.

Class com.amazonaws.services.identitymanagement.model.GetSSHPublicKeyRequest

class GetSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

sSHPublicKeyId

String sSHPublicKeyId

The unique identifier for the SSH public key.

The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

userName

String userName

The name of the IAM user associated with the SSH public key.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetSSHPublicKeyResult

class GetSSHPublicKeyResult extends Object implements Serializable

Serialized Fields

sSHPublicKey

SSHPublicKey sSHPublicKey

A structure containing details about the SSH public key.

Class com.amazonaws.services.identitymanagement.model.GetUserPolicyRequest

class GetUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the policy document to get.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

userName

String userName

The name of the user who the policy is associated with.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetUserPolicyResult

class GetUserPolicyResult extends Object implements Serializable

Serialized Fields

policyDocument

String policyDocument

The policy document.

policyName

String policyName

The name of the policy.

userName

String userName

The user the policy is associated with.

Class com.amazonaws.services.identitymanagement.model.GetUserRequest

class 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. The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.GetUserResult

class GetUserResult extends Object implements Serializable

Serialized Fields

user

User user

A structure containing details about the IAM user.

Class com.amazonaws.services.identitymanagement.model.Group

class Group extends Object implements Serializable

Serialized Fields

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.

groupId

String groupId

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

groupName

String groupName

The friendly name that identifies the group.

path

String path

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

Class com.amazonaws.services.identitymanagement.model.GroupDetail

class GroupDetail extends Object implements Serializable

Serialized Fields

arn

String arn

attachedManagedPolicies

com.amazonaws.internal.SdkInternalList<AttachedPolicy> attachedManagedPolicies

A list of the managed policies attached to the group.

createDate

Date createDate

The date and time, in ISO 8601 date-time format, when the group was created.

groupId

String groupId

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the Using IAM guide.

groupName

String groupName

The friendly name that identifies the group.

groupPolicyList

com.amazonaws.internal.SdkInternalList<PolicyDetail> groupPolicyList

A list of the inline policies embedded in the group.

path

String path

The path to the group. For more information about paths, see IAM Identifiers in the Using IAM guide.

Class com.amazonaws.services.identitymanagement.model.InstanceProfile

class InstanceProfile extends Object implements Serializable

Serialized Fields

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.

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.

instanceProfileName

String instanceProfileName

The name identifying the instance profile.

path

String path

The path to the instance profile. For more information about paths, see IAM Identifiers in the Using IAM guide.

roles

com.amazonaws.internal.SdkInternalList<Role> roles

The role associated with the instance profile.

Exception Class com.amazonaws.services.identitymanagement.model.InvalidAuthenticationCodeException

class InvalidAuthenticationCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.InvalidCertificateException

class InvalidCertificateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.InvalidInputException

class InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.InvalidPublicKeyException

class InvalidPublicKeyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.InvalidUserTypeException

class InvalidUserTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.KeyPairMismatchException

class KeyPairMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.ListAccessKeysRequest

class ListAccessKeysRequest 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.

userName

String userName

The name of the user.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListAccessKeysResult

class ListAccessKeysResult extends Object implements Serializable

Serialized Fields

accessKeyMetadata

com.amazonaws.internal.SdkInternalList<AccessKeyMetadata> accessKeyMetadata

A list of objects containing metadata about the access 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.ListAccountAliasesRequest

class 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

class ListAccountAliasesResult extends Object implements Serializable

Serialized Fields

accountAliases

com.amazonaws.internal.SdkInternalList<String> 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

class ListAttachedGroupPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name (friendly name, not ARN) of the group to list attached policies for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

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.

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.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.ListAttachedGroupPoliciesResult

class ListAttachedGroupPoliciesResult extends Object implements Serializable

Serialized Fields

attachedPolicies

com.amazonaws.internal.SdkInternalList<AttachedPolicy> 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

class ListAttachedRolePoliciesRequest 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.

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.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

roleName

String roleName

The name (friendly name, not ARN) of the role to list attached policies for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListAttachedRolePoliciesResult

class ListAttachedRolePoliciesResult extends Object implements Serializable

Serialized Fields

attachedPolicies

com.amazonaws.internal.SdkInternalList<AttachedPolicy> 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

class ListAttachedUserPoliciesRequest 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.

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.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

userName

String userName

The name (friendly name, not ARN) of the user to list attached policies for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListAttachedUserPoliciesResult

class ListAttachedUserPoliciesResult extends Object implements Serializable

Serialized Fields

attachedPolicies

com.amazonaws.internal.SdkInternalList<AttachedPolicy> 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

class ListEntitiesForPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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. The argument for this parameter must be one of the valid values listed below.

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.

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.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.ListEntitiesForPolicyResult

class ListEntitiesForPolicyResult extends Object implements Serializable

Serialized Fields

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.

policyGroups

com.amazonaws.internal.SdkInternalList<PolicyGroup> policyGroups

A list of IAM groups that the policy is attached to.

policyRoles

com.amazonaws.internal.SdkInternalList<PolicyRole> policyRoles

A list of IAM roles that the policy is attached to.

policyUsers

com.amazonaws.internal.SdkInternalList<PolicyUser> policyUsers

A list of IAM users that the policy is attached to.

Class com.amazonaws.services.identitymanagement.model.ListGroupPoliciesRequest

class ListGroupPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group to list policies for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

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

class ListGroupPoliciesResult extends Object implements Serializable

Serialized Fields

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.

policyNames

com.amazonaws.internal.SdkInternalList<String> policyNames

A list of policy names.

Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserRequest

class ListGroupsForUserRequest 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.

userName

String userName

The name of the user to list groups for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListGroupsForUserResult

class ListGroupsForUserResult extends Object implements Serializable

Serialized Fields

groups

com.amazonaws.internal.SdkInternalList<Group> 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

class ListGroupsRequest 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.

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. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.ListGroupsResult

class ListGroupsResult extends Object implements Serializable

Serialized Fields

groups

com.amazonaws.internal.SdkInternalList<Group> 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

class ListInstanceProfilesForRoleRequest 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.

roleName

String roleName

The name of the role to list instance profiles for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesForRoleResult

class ListInstanceProfilesForRoleResult extends Object implements Serializable

Serialized Fields

instanceProfiles

com.amazonaws.internal.SdkInternalList<InstanceProfile> 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

class ListInstanceProfilesRequest 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.

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. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.ListInstanceProfilesResult

class ListInstanceProfilesResult extends Object implements Serializable

Serialized Fields

instanceProfiles

com.amazonaws.internal.SdkInternalList<InstanceProfile> 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

class ListMFADevicesRequest 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.

userName

String userName

The name of the user whose MFA devices you want to list.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListMFADevicesResult

class ListMFADevicesResult extends Object implements Serializable

Serialized Fields

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.

mFADevices

com.amazonaws.internal.SdkInternalList<MFADevice> mFADevices

A list of MFA devices.

Class com.amazonaws.services.identitymanagement.model.ListOpenIDConnectProvidersRequest

class ListOpenIDConnectProvidersRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.ListOpenIDConnectProvidersResult

class ListOpenIDConnectProvidersResult extends Object implements Serializable

Serialized Fields

openIDConnectProviderList

com.amazonaws.internal.SdkInternalList<OpenIDConnectProviderListEntry> openIDConnectProviderList

The list of IAM OIDC provider resource objects defined in the AWS account.

Class com.amazonaws.services.identitymanagement.model.ListPoliciesRequest

class ListPoliciesRequest 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.

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 an IAM 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. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

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.

Class com.amazonaws.services.identitymanagement.model.ListPoliciesResult

class ListPoliciesResult extends Object implements Serializable

Serialized Fields

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.

policies

com.amazonaws.internal.SdkInternalList<Policy> policies

A list of policies.

Class com.amazonaws.services.identitymanagement.model.ListPolicyVersionsRequest

class ListPolicyVersionsRequest 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.

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy for which you want the versions.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.ListPolicyVersionsResult

class ListPolicyVersionsResult extends Object implements Serializable

Serialized Fields

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.

versions

com.amazonaws.internal.SdkInternalList<PolicyVersion> versions

A list of policy versions.

For more information about managed policy versions, see Versioning for Managed Policies in the IAM User Guide.

Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesRequest

class ListRolePoliciesRequest 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.

roleName

String roleName

The name of the role to list policies for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListRolePoliciesResult

class ListRolePoliciesResult extends Object implements Serializable

Serialized Fields

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.

policyNames

com.amazonaws.internal.SdkInternalList<String> policyNames

A list of policy names.

Class com.amazonaws.services.identitymanagement.model.ListRolesRequest

class ListRolesRequest 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.

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. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.ListRolesResult

class ListRolesResult extends Object implements Serializable

Serialized Fields

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.

roles

com.amazonaws.internal.SdkInternalList<Role> roles

A list of roles.

Class com.amazonaws.services.identitymanagement.model.ListSAMLProvidersRequest

class ListSAMLProvidersRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.identitymanagement.model.ListSAMLProvidersResult

class ListSAMLProvidersResult extends Object implements Serializable

Serialized Fields

sAMLProviderList

com.amazonaws.internal.SdkInternalList<SAMLProviderListEntry> sAMLProviderList

The list of SAML provider resource objects defined in IAM for this AWS account.

Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesRequest

class ListServerCertificatesRequest 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.

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. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.ListServerCertificatesResult

class ListServerCertificatesResult extends Object implements Serializable

Serialized Fields

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.

serverCertificateMetadataList

com.amazonaws.internal.SdkInternalList<ServerCertificateMetadata> serverCertificateMetadataList

A list of server certificates.

Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesRequest

class ListSigningCertificatesRequest 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.

userName

String userName

The name of the IAM user whose signing certificates you want to examine.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListSigningCertificatesResult

class ListSigningCertificatesResult extends Object implements Serializable

Serialized Fields

certificates

com.amazonaws.internal.SdkInternalList<SigningCertificate> 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

class ListSSHPublicKeysRequest 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.

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.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListSSHPublicKeysResult

class ListSSHPublicKeysResult extends Object implements Serializable

Serialized Fields

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.

sSHPublicKeys

com.amazonaws.internal.SdkInternalList<SSHPublicKeyMetadata> sSHPublicKeys

A list of the SSH public keys assigned to IAM user.

Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesRequest

class ListUserPoliciesRequest 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.

userName

String userName

The name of the user to list policies for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ListUserPoliciesResult

class ListUserPoliciesResult extends Object implements Serializable

Serialized Fields

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.

policyNames

com.amazonaws.internal.SdkInternalList<String> policyNames

A list of policy names.

Class com.amazonaws.services.identitymanagement.model.ListUsersRequest

class ListUsersRequest 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.

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. The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.ListUsersResult

class ListUsersResult extends Object implements Serializable

Serialized Fields

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.

users

com.amazonaws.internal.SdkInternalList<User> users

A list of users.

Class com.amazonaws.services.identitymanagement.model.ListVirtualMFADevicesRequest

class 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

class ListVirtualMFADevicesResult extends Object implements Serializable

Serialized Fields

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.

virtualMFADevices

com.amazonaws.internal.SdkInternalList<VirtualMFADevice> virtualMFADevices

The list of virtual MFA devices in the current account that match the AssignmentStatus value that was passed in the request.

Class com.amazonaws.services.identitymanagement.model.LoginProfile

class LoginProfile extends Object implements Serializable

Serialized Fields

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.

userName

String userName

The name of the user, which can be used for signing in to the AWS Management Console.

Exception Class com.amazonaws.services.identitymanagement.model.MalformedCertificateException

class MalformedCertificateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.identitymanagement.model.MalformedPolicyDocumentException

class MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.ManagedPolicyDetail

class ManagedPolicyDetail extends Object implements Serializable

Serialized Fields

arn

String arn

attachmentCount

Integer attachmentCount

The number of principal entities (users, groups, and roles) that the policy is attached to.

createDate

Date createDate

The date and time, in ISO 8601 date-time format, when the policy was created.

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.

description

String description

A friendly description of the policy.

isAttachable

Boolean isAttachable

Specifies whether the policy can be attached to an IAM user, group, or role.

path

String path

The path to the policy.

For more information about paths, see IAM Identifiers in the Using IAM guide.

policyId

String policyId

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the Using IAM guide.

policyName

String policyName

The friendly name (not ARN) identifying the policy.

policyVersionList

com.amazonaws.internal.SdkInternalList<PolicyVersion> policyVersionList

A list containing information about the versions of the policy.

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

class MFADevice extends Object implements Serializable

Serialized Fields

enableDate

Date enableDate

The date when the MFA device was enabled for the user.

serialNumber

String serialNumber

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

userName

String userName

The user with whom the MFA device is associated.

Exception Class com.amazonaws.services.identitymanagement.model.NoSuchEntityException

class NoSuchEntityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.OpenIDConnectProviderListEntry

class OpenIDConnectProviderListEntry extends Object implements Serializable

Serialized Fields

arn

String arn

Class com.amazonaws.services.identitymanagement.model.PasswordPolicy

class PasswordPolicy extends Object implements Serializable

Serialized Fields

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.

hardExpiry

Boolean hardExpiry

Specifies whether IAM users are prevented from setting a new password after their password has expired.

maxPasswordAge

Integer maxPasswordAge

The number of days that an IAM user password is valid.

minimumPasswordLength

Integer minimumPasswordLength

Minimum length to require for IAM user passwords.

passwordReusePrevention

Integer passwordReusePrevention

Specifies the number of previous passwords that IAM users are prevented from reusing.

requireLowercaseCharacters

Boolean requireLowercaseCharacters

Specifies whether to require lowercase characters for IAM user passwords.

requireNumbers

Boolean requireNumbers

Specifies whether to require numbers for IAM user passwords.

requireSymbols

Boolean requireSymbols

Specifies whether to require symbols for IAM user passwords.

requireUppercaseCharacters

Boolean requireUppercaseCharacters

Specifies whether to require uppercase characters for IAM user passwords.

Exception Class com.amazonaws.services.identitymanagement.model.PasswordPolicyViolationException

class PasswordPolicyViolationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.Policy

class Policy extends Object implements Serializable

Serialized Fields

arn

String arn

attachmentCount

Integer attachmentCount

The number of entities (users, groups, and roles) that the policy is attached to.

createDate

Date createDate

The date and time, in ISO 8601 date-time format, when the policy was created.

defaultVersionId

String defaultVersionId

The identifier for the version of the policy that is set as the default version.

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.

isAttachable

Boolean isAttachable

Specifies whether the policy can be attached to an IAM user, group, or role.

path

String path

The path to the policy.

For more information about paths, see IAM Identifiers in the Using IAM guide.

policyId

String policyId

The stable and unique string identifying the policy.

For more information about IDs, see IAM Identifiers in the Using IAM guide.

policyName

String policyName

The friendly name (not ARN) identifying the policy.

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

class PolicyDetail extends Object implements Serializable

Serialized Fields

policyDocument

String policyDocument

The policy document.

policyName

String policyName

The name of the policy.

Exception Class com.amazonaws.services.identitymanagement.model.PolicyEvaluationException

class PolicyEvaluationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.PolicyGroup

class PolicyGroup extends Object implements Serializable

Serialized Fields

groupId

String groupId

The stable and unique string identifying the group. For more information about IDs, see IAM Identifiers in the IAM User Guide.

groupName

String groupName

The name (friendly name, not ARN) identifying the group.

Class com.amazonaws.services.identitymanagement.model.PolicyRole

class PolicyRole extends Object implements Serializable

Serialized Fields

roleId

String roleId

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the IAM User Guide.

roleName

String roleName

The name (friendly name, not ARN) identifying the role.

Class com.amazonaws.services.identitymanagement.model.PolicyUser

class PolicyUser extends Object implements Serializable

Serialized Fields

userId

String userId

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the IAM User Guide.

userName

String userName

The name (friendly name, not ARN) identifying the user.

Class com.amazonaws.services.identitymanagement.model.PolicyVersion

class PolicyVersion extends Object implements Serializable

Serialized Fields

createDate

Date createDate

The date and time, in ISO 8601 date-time format, when the policy version was created.

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.

isDefaultVersion

Boolean isDefaultVersion

Specifies whether the policy version is set as the policy's default version.

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.

Class com.amazonaws.services.identitymanagement.model.Position

class Position extends Object implements Serializable

Serialized Fields

column

Integer column

The column in the line containing the specified position in the document.

line

Integer line

The line containing the specified position in the document.

Class com.amazonaws.services.identitymanagement.model.PutGroupPolicyRequest

class PutGroupPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group to associate the policy with.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

policyDocument

String policyDocument

The policy document.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

policyName

String policyName

The name of the policy document.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.PutGroupPolicyResult

class PutGroupPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.PutRolePolicyRequest

class PutRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

String policyDocument

The policy document.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

policyName

String policyName

The name of the policy document.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

roleName

String roleName

The name of the role to associate the policy with.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.PutRolePolicyResult

class PutRolePolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.PutUserPolicyRequest

class PutUserPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

String policyDocument

The policy document.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

policyName

String policyName

The name of the policy document.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

userName

String userName

The name of the user to associate the policy with.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.PutUserPolicyResult

class PutUserPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.RemoveClientIDFromOpenIDConnectProviderRequest

class RemoveClientIDFromOpenIDConnectProviderRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientID

String clientID

The client ID (also known as audience) to remove from the IAM OIDC provider resource. For more information about client IDs, see CreateOpenIDConnectProvider.

openIDConnectProviderArn

String openIDConnectProviderArn

The Amazon Resource Name (ARN) of the IAM OIDC provider resource to remove the client ID from. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.RemoveClientIDFromOpenIDConnectProviderResult

class RemoveClientIDFromOpenIDConnectProviderResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.RemoveRoleFromInstanceProfileRequest

class RemoveRoleFromInstanceProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceProfileName

String instanceProfileName

The name of the instance profile to update.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

roleName

String roleName

The name of the role to remove.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.RemoveRoleFromInstanceProfileResult

class RemoveRoleFromInstanceProfileResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.RemoveUserFromGroupRequest

class RemoveUserFromGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

The name of the group to update.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

userName

String userName

The name of the user to remove.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.RemoveUserFromGroupResult

class RemoveUserFromGroupResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.ResourceSpecificResult

class ResourceSpecificResult extends Object implements Serializable

Serialized Fields

evalDecisionDetails

com.amazonaws.internal.SdkInternalMap<String,String> 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.

evalResourceDecision

String evalResourceDecision

The result of the simulation of the simulated API action on the resource specified in EvalResourceName.

evalResourceName

String evalResourceName

The name of the simulated resource, in Amazon Resource Name (ARN) format.

matchedStatements

com.amazonaws.internal.SdkInternalList<Statement> 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<String> 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. This list is used when a list of ARNs is included in the ResourceArns parameter instead of "*". If you do not specify individual resources, by setting ResourceArns to "*" or by not including the ResourceArns parameter, then any missing context values are instead included under the EvaluationResults section. To discover the context keys used by a set of policies, you can call GetContextKeysForCustomPolicy or GetContextKeysForPrincipalPolicy.

Class com.amazonaws.services.identitymanagement.model.ResyncMFADeviceRequest

class ResyncMFADeviceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

authenticationCode1

String authenticationCode1

An authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

authenticationCode2

String authenticationCode2

A subsequent authentication code emitted by the device.

The format for this parameter is a sequence of six digits.

serialNumber

String serialNumber

Serial number that uniquely identifies the MFA device.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

userName

String userName

The name of the user whose MFA device you want to resynchronize.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.ResyncMFADeviceResult

class ResyncMFADeviceResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.Role

class Role extends Object implements Serializable

Serialized Fields

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.

assumeRolePolicyDocument

String assumeRolePolicyDocument

The policy that grants an entity permission to assume the role.

createDate

Date createDate

The date and time, in ISO 8601 date-time format, when the role was created.

path

String path

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

roleId

String roleId

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

roleName

String roleName

The friendly name that identifies the role.

Class com.amazonaws.services.identitymanagement.model.RoleDetail

class RoleDetail extends Object implements Serializable

Serialized Fields

arn

String arn

assumeRolePolicyDocument

String assumeRolePolicyDocument

The trust policy that grants permission to assume the role.

attachedManagedPolicies

com.amazonaws.internal.SdkInternalList<AttachedPolicy> attachedManagedPolicies

A list of managed policies attached to the role. These policies are the role's access (permissions) policies.

createDate

Date createDate

The date and time, in ISO 8601 date-time format, when the role was created.

instanceProfileList

com.amazonaws.internal.SdkInternalList<InstanceProfile> instanceProfileList

path

String path

The path to the role. For more information about paths, see IAM Identifiers in the Using IAM guide.

roleId

String roleId

The stable and unique string identifying the role. For more information about IDs, see IAM Identifiers in the Using IAM guide.

roleName

String roleName

The friendly name that identifies the role.

rolePolicyList

com.amazonaws.internal.SdkInternalList<PolicyDetail> rolePolicyList

A list of inline policies embedded in the role. These policies are the role's access (permissions) policies.

Class com.amazonaws.services.identitymanagement.model.SAMLProviderListEntry

class SAMLProviderListEntry extends Object implements Serializable

Serialized Fields

arn

String arn

The Amazon Resource Name (ARN) of the SAML 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.ServerCertificate

class ServerCertificate extends Object implements Serializable

Serialized Fields

certificateBody

String certificateBody

The contents of the public key certificate.

certificateChain

String certificateChain

The contents of the public key certificate chain.

serverCertificateMetadata

ServerCertificateMetadata serverCertificateMetadata

The meta information of the server certificate, such as its name, path, ID, and ARN.

Class com.amazonaws.services.identitymanagement.model.ServerCertificateMetadata

class ServerCertificateMetadata extends Object implements Serializable

Serialized Fields

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.

expiration

Date expiration

The date on which the certificate is set to expire.

path

String path

The path to the server certificate. For more information about paths, see IAM Identifiers in the Using IAM guide.

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.

serverCertificateName

String serverCertificateName

The name that identifies the server certificate.

uploadDate

Date uploadDate

The date when the server certificate was uploaded.

Exception Class com.amazonaws.services.identitymanagement.model.ServiceFailureException

class ServiceFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.SetDefaultPolicyVersionRequest

class SetDefaultPolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyArn

String policyArn

The Amazon Resource Name (ARN) of the IAM policy whose default version you want to set.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

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

class SetDefaultPolicyVersionResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.SigningCertificate

class SigningCertificate extends Object implements Serializable

Serialized Fields

certificateBody

String certificateBody

The contents of the signing certificate.

certificateId

String certificateId

The ID for 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.

userName

String userName

The name of the user the signing certificate is associated with.

Class com.amazonaws.services.identitymanagement.model.SimulateCustomPolicyRequest

class SimulateCustomPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionNames

com.amazonaws.internal.SdkInternalList<String> 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.

callerArn

String callerArn

The ARN of the IAM 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<ContextEntry> contextEntries

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

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.

policyInputList

com.amazonaws.internal.SdkInternalList<String> 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.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

resourceArns

com.amazonaws.internal.SdkInternalList<String> 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.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

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

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.

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.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Class com.amazonaws.services.identitymanagement.model.SimulateCustomPolicyResult

class SimulateCustomPolicyResult extends Object implements Serializable

Serialized Fields

evaluationResults

com.amazonaws.internal.SdkInternalList<EvaluationResult> 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

class SimulatePrincipalPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

actionNames

com.amazonaws.internal.SdkInternalList<String> 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.

callerArn

String callerArn

The ARN of the IAM 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.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

contextEntries

com.amazonaws.internal.SdkInternalList<ContextEntry> contextEntries

A list of context keys and corresponding values for the simulation to use. Whenever a context key is evaluated in one of the simulated IAM permission policies, the corresponding value is supplied.

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.

policyInputList

com.amazonaws.internal.SdkInternalList<String> 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.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

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.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

resourceArns

com.amazonaws.internal.SdkInternalList<String> 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.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

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

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.

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.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Class com.amazonaws.services.identitymanagement.model.SimulatePrincipalPolicyResult

class SimulatePrincipalPolicyResult extends Object implements Serializable

Serialized Fields

evaluationResults

com.amazonaws.internal.SdkInternalList<EvaluationResult> 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

class SSHPublicKey extends Object implements Serializable

Serialized Fields

fingerprint

String fingerprint

The MD5 message digest of the SSH public key.

sSHPublicKeyBody

String sSHPublicKeyBody

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.

userName

String userName

The name of the IAM user associated with the SSH public key.

Class com.amazonaws.services.identitymanagement.model.SSHPublicKeyMetadata

class SSHPublicKeyMetadata extends Object implements Serializable

Serialized Fields

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.

userName

String userName

The name of the IAM user associated with the SSH public key.

Class com.amazonaws.services.identitymanagement.model.Statement

class Statement extends Object implements Serializable

Serialized Fields

endPosition

Position endPosition

The row and column of the end of a Statement in an IAM policy.

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.

Exception Class com.amazonaws.services.identitymanagement.model.UnrecognizedPublicKeyEncodingException

class UnrecognizedPublicKeyEncodingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.identitymanagement.model.UpdateAccessKeyRequest

class UpdateAccessKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessKeyId

String accessKeyId

The access key ID of the secret access key you want to update.

The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

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.

userName

String userName

The name of the user whose key you want to update.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UpdateAccessKeyResult

class UpdateAccessKeyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateAccountPasswordPolicyRequest

class UpdateAccountPasswordPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

hardExpiry

Boolean hardExpiry

Prevents IAM users from setting a new password after their password has expired.

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

minimumPasswordLength

Integer minimumPasswordLength

The minimum number of characters allowed in an IAM user password.

Default value: 6

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

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

requireNumbers

Boolean requireNumbers

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

Default value: false

requireSymbols

Boolean requireSymbols

Specifies whether IAM user passwords must contain at least one of the following non-alphanumeric characters:

! @ # $ % ^ &amp; * ( ) _ + - = [ ] { } | '

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

Class com.amazonaws.services.identitymanagement.model.UpdateAccountPasswordPolicyResult

class UpdateAccountPasswordPolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateAssumeRolePolicyRequest

class UpdateAssumeRolePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

String policyDocument

The policy that grants an entity permission to assume the role.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

roleName

String roleName

The name of the role to update with the new policy.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UpdateAssumeRolePolicyResult

class UpdateAssumeRolePolicyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateGroupRequest

class UpdateGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

groupName

String groupName

Name of the IAM group to update. If you're changing the name of the group, this is the original name.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

newGroupName

String newGroupName

New name for the IAM group. Only include this if changing the group's name.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

newPath

String newPath

New path for the IAM group. Only include this if changing the group's path.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Class com.amazonaws.services.identitymanagement.model.UpdateGroupResult

class UpdateGroupResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateLoginProfileRequest

class UpdateLoginProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

password

String password

The new password for the specified IAM user.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ). However, the format can be further restricted by the account administrator by setting a password policy on the AWS account. For more information, see UpdateAccountPasswordPolicy.

passwordResetRequired

Boolean passwordResetRequired

Allows this new password to be used only once by requiring the specified IAM user to set a new password on next sign-in.

userName

String userName

The name of the user whose password you want to update.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UpdateLoginProfileResult

class UpdateLoginProfileResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateOpenIDConnectProviderThumbprintRequest

class UpdateOpenIDConnectProviderThumbprintRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

openIDConnectProviderArn

String openIDConnectProviderArn

The Amazon Resource Name (ARN) of the IAM OIDC provider resource object for which you want to update the thumbprint. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders action.

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

thumbprintList

com.amazonaws.internal.SdkInternalList<String> 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.UpdateOpenIDConnectProviderThumbprintResult

class UpdateOpenIDConnectProviderThumbprintResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateSAMLProviderRequest

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

For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

Class com.amazonaws.services.identitymanagement.model.UpdateSAMLProviderResult

class 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

class UpdateServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

newPath

String newPath

The new path for the server certificate. Include this only if you are updating the server certificate's path.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

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.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

serverCertificateName

String serverCertificateName

The name of the server certificate that you want to update.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UpdateServerCertificateResult

class UpdateServerCertificateResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateSigningCertificateRequest

class UpdateSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the signing certificate you want to update.

The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

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.

userName

String userName

The name of the IAM user the signing certificate belongs to.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UpdateSigningCertificateResult

class UpdateSigningCertificateResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateSSHPublicKeyRequest

class UpdateSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sSHPublicKeyId

String sSHPublicKeyId

The unique identifier for the SSH public key.

The regex pattern for this parameter is a string of characters that can consist of any upper or lowercased letter or digit.

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.

userName

String userName

The name of the IAM user associated with the SSH public key.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UpdateSSHPublicKeyResult

class UpdateSSHPublicKeyResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UpdateUserRequest

class UpdateUserRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

newPath

String newPath

New path for the IAM user. Include this parameter only if you're changing the user's path.

The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

newUserName

String newUserName

New name for the user. Include this parameter only if you're changing the user's name.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

userName

String userName

Name of the user to update. If you're changing the name of the user, this is the original user name.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UpdateUserResult

class UpdateUserResult extends Object implements Serializable

Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateRequest

class UploadServerCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateBody

String certificateBody

The contents of the public key certificate in PEM-encoded format.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

certificateChain

String certificateChain

The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

path

String path

The path for the server certificate. 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 (/). The regex pattern for this parameter is a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

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

privateKey

String privateKey

The contents of the private key in PEM-encoded format.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

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.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UploadServerCertificateResult

class 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

class UploadSigningCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateBody

String certificateBody

The contents of the signing certificate.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

userName

String userName

The name of the user the signing certificate is for.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UploadSigningCertificateResult

class UploadSigningCertificateResult extends Object implements Serializable

Serialized Fields

certificate

SigningCertificate certificate

Information about the certificate.

Class com.amazonaws.services.identitymanagement.model.UploadSSHPublicKeyRequest

class UploadSSHPublicKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sSHPublicKeyBody

String sSHPublicKeyBody

The SSH public key. The public key must be encoded in ssh-rsa format or PEM format.

The regex pattern for this parameter is a string of characters consisting of any printable ASCII character ranging from the space character ( ) through end of the ASCII character range (ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

userName

String userName

The name of the IAM user to associate the SSH public key with.

The regex pattern for this parameter is a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Class com.amazonaws.services.identitymanagement.model.UploadSSHPublicKeyResult

class UploadSSHPublicKeyResult extends Object implements Serializable

Serialized Fields

sSHPublicKey

SSHPublicKey sSHPublicKey

Contains information about the SSH public key.

Class com.amazonaws.services.identitymanagement.model.User

class User extends Object implements Serializable

Serialized Fields

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.

path

String path

The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

userId

String userId

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

userName

String userName

The friendly name identifying the user.

Class com.amazonaws.services.identitymanagement.model.UserDetail

class UserDetail extends Object implements Serializable

Serialized Fields

arn

String arn

attachedManagedPolicies

com.amazonaws.internal.SdkInternalList<AttachedPolicy> attachedManagedPolicies

A list of the managed policies attached to the user.

createDate

Date createDate

The date and time, in ISO 8601 date-time format, when the user was created.

groupList

com.amazonaws.internal.SdkInternalList<String> groupList

A list of IAM groups that the user is in.

path

String path

The path to the user. For more information about paths, see IAM Identifiers in the Using IAM guide.

userId

String userId

The stable and unique string identifying the user. For more information about IDs, see IAM Identifiers in the Using IAM guide.

userName

String userName

The friendly name identifying the user.

userPolicyList

com.amazonaws.internal.SdkInternalList<PolicyDetail> userPolicyList

A list of the inline policies embedded in the user.

Class com.amazonaws.services.identitymanagement.model.VirtualMFADevice

class VirtualMFADevice extends Object implements Serializable

Serialized Fields

base32StringSeed

ByteBuffer base32StringSeed

The Base32 seed defined as specified in RFC3548. The Base32StringSeed is Base64-encoded.

enableDate

Date enableDate

The date and time on which the virtual MFA device was enabled.

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.

serialNumber

String serialNumber

The serial number associated with VirtualMFADevice.

user

User user

Package com.amazonaws.services.importexport.model

Class com.amazonaws.services.importexport.model.Artifact

class Artifact extends Object implements Serializable

Serialized Fields

description

String description

uRL

String uRL

Exception Class com.amazonaws.services.importexport.model.BucketPermissionException

class BucketPermissionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.CanceledJobIdException

class CanceledJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.importexport.model.CancelJobRequest

class CancelJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPIVersion

String aPIVersion

jobId

String jobId

Class com.amazonaws.services.importexport.model.CancelJobResult

class CancelJobResult extends Object implements Serializable

Serialized Fields

success

Boolean success

Exception Class com.amazonaws.services.importexport.model.CreateJobQuotaExceededException

class CreateJobQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.importexport.model.CreateJobRequest

class CreateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPIVersion

String aPIVersion

jobType

String jobType

manifest

String manifest

manifestAddendum

String manifestAddendum

validateOnly

Boolean validateOnly

Class com.amazonaws.services.importexport.model.CreateJobResult

class CreateJobResult extends Object implements Serializable

Serialized Fields

artifactList

com.amazonaws.internal.SdkInternalList<Artifact> artifactList

jobId

String jobId

jobType

String jobType

signature

String signature

signatureFileContents

String signatureFileContents

warningMessage

String warningMessage

Exception Class com.amazonaws.services.importexport.model.ExpiredJobIdException

class ExpiredJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.importexport.model.GetShippingLabelRequest

class GetShippingLabelRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPIVersion

String aPIVersion

city

String city

company

String company

country

String country

jobIds

com.amazonaws.internal.SdkInternalList<String> jobIds

name

String name

phoneNumber

String phoneNumber

postalCode

String postalCode

stateOrProvince

String stateOrProvince

street1

String street1

street2

String street2

street3

String street3

Class com.amazonaws.services.importexport.model.GetShippingLabelResult

class GetShippingLabelResult extends Object implements Serializable

Serialized Fields

shippingLabelURL

String shippingLabelURL

warning

String warning

Class com.amazonaws.services.importexport.model.GetStatusRequest

class GetStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPIVersion

String aPIVersion

jobId

String jobId

Class com.amazonaws.services.importexport.model.GetStatusResult

class GetStatusResult extends Object implements Serializable

Serialized Fields

artifactList

com.amazonaws.internal.SdkInternalList<Artifact> artifactList

carrier

String carrier

creationDate

Date creationDate

currentManifest

String currentManifest

errorCount

Integer errorCount

jobId

String jobId

jobType

String jobType

locationCode

String locationCode

locationMessage

String locationMessage

logBucket

String logBucket

logKey

String logKey

progressCode

String progressCode

progressMessage

String progressMessage

signature

String signature

signatureFileContents

String signatureFileContents

trackingNumber

String trackingNumber

Exception Class com.amazonaws.services.importexport.model.InvalidAccessKeyIdException

class InvalidAccessKeyIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.InvalidAddressException

class InvalidAddressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.InvalidCustomsException

class InvalidCustomsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.InvalidFileSystemException

class InvalidFileSystemException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.InvalidJobIdException

class InvalidJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.InvalidManifestFieldException

class InvalidManifestFieldException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.InvalidVersionException

class InvalidVersionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.importexport.model.Job

class Job extends Object implements Serializable

Serialized Fields

creationDate

Date creationDate

isCanceled

Boolean isCanceled

jobId

String jobId

jobType

String jobType

Class com.amazonaws.services.importexport.model.ListJobsRequest

class ListJobsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPIVersion

String aPIVersion

marker

String marker

maxJobs

Integer maxJobs

Class com.amazonaws.services.importexport.model.ListJobsResult

class ListJobsResult extends Object implements Serializable

Serialized Fields

isTruncated

Boolean isTruncated

jobs

com.amazonaws.internal.SdkInternalList<Job> jobs

Exception Class com.amazonaws.services.importexport.model.MalformedManifestException

class MalformedManifestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.MissingCustomsException

class MissingCustomsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.MissingManifestFieldException

class MissingManifestFieldException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.MissingParameterException

class MissingParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.MultipleRegionsException

class MultipleRegionsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.NoSuchBucketException

class NoSuchBucketException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.UnableToCancelJobIdException

class UnableToCancelJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.importexport.model.UnableToUpdateJobIdException

class UnableToUpdateJobIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.importexport.model.UpdateJobRequest

class UpdateJobRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

aPIVersion

String aPIVersion

jobId

String jobId

jobType

String jobType

manifest

String manifest

validateOnly

Boolean validateOnly

Class com.amazonaws.services.importexport.model.UpdateJobResult

class UpdateJobResult extends Object implements Serializable

Serialized Fields

artifactList

com.amazonaws.internal.SdkInternalList<Artifact> artifactList

success

Boolean success

warningMessage

String warningMessage

Package com.amazonaws.services.inspector.model

Exception Class com.amazonaws.services.inspector.model.AccessDeniedException

class AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

canRetry

Boolean canRetry

You can immediately retry your request.

errorCode

String errorCode

Code that indicates the type of error that is generated.

Class com.amazonaws.services.inspector.model.AddAttributesToFindingsRequest

class AddAttributesToFindingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

List<Attribute> attributes

The array of attributes that you want to assign to specified findings.

findingArns

List<String> findingArns

The ARNs that specify the findings that you want to assign attributes to.

Class com.amazonaws.services.inspector.model.AddAttributesToFindingsResult

class AddAttributesToFindingsResult extends Object implements Serializable

Serialized Fields

failedItems

Map<String, FailedItemDetails> failedItems

Attribute details that cannot be described. An error code is provided for each failed item.

Class com.amazonaws.services.inspector.model.AgentAlreadyRunningAssessment

class AgentAlreadyRunningAssessment extends Object implements Serializable

Serialized Fields

agentId

String agentId

ID of the agent that is running on an EC2 instance that is already participating in another started assessment run.

assessmentRunArn

String assessmentRunArn

The ARN of the assessment run that has already been started.

Class com.amazonaws.services.inspector.model.AgentFilter

class AgentFilter extends Object implements Serializable

Serialized Fields

agentHealthCodes

List<String> agentHealthCodes

The detailed health state of the agent. Values can be set to IDLE, RUNNING, SHUTDOWN, UNHEALTHY, THROTTLED, and UNKNOWN.

agentHealths

List<String> agentHealths

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

Class com.amazonaws.services.inspector.model.AgentPreview

class AgentPreview extends Object implements Serializable

Serialized Fields

agentId

String agentId

The ID of the EC2 instance where the agent is installed.

autoScalingGroup

String autoScalingGroup

The Auto Scaling group for the EC2 instance where the agent is installed.

Exception Class com.amazonaws.services.inspector.model.AgentsAlreadyRunningAssessmentException

class AgentsAlreadyRunningAssessmentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

agents

List<AgentAlreadyRunningAssessment> agents

agentsTruncated

Boolean agentsTruncated

canRetry

Boolean canRetry

You can immediately retry your request.

Class com.amazonaws.services.inspector.model.AssessmentRun

class AssessmentRun extends Object implements Serializable

Serialized Fields

arn

String arn

The ARN of the assessment run.

assessmentTemplateArn

String assessmentTemplateArn

The ARN of the assessment template that is associated with the assessment run.

completedAt

Date completedAt

The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

createdAt

Date createdAt

The time when StartAssessmentRun was called.

dataCollected

Boolean dataCollected

A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

durationInSeconds

Integer durationInSeconds

The duration of the assessment run.

name

String name

The auto-generated name for the assessment run.

notifications

List<AssessmentRunNotification> notifications

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

rulesPackageArns

List<String> rulesPackageArns

The rules packages selected for the assessment run.

startedAt

Date startedAt

The time when StartAssessmentRun was called.

state

String state

The state of the assessment run.

stateChangedAt

Date stateChangedAt

The last time when the assessment run's state changed.

stateChanges

List<AssessmentRunStateChange> stateChanges

A list of the assessment run state changes.

userAttributesForFindings

List<Attribute> userAttributesForFindings

The user-defined attributes that are assigned to every generated finding.

Class com.amazonaws.services.inspector.model.AssessmentRunAgent

class AssessmentRunAgent extends Object implements Serializable

Serialized Fields

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.

agentId

String agentId

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

autoScalingGroup

String autoScalingGroup

The Auto Scaling group of the EC2 instance that is specified by the agent ID.

telemetryMetadata

List<TelemetryMetadata> telemetryMetadata

The Amazon Inspector application data metrics that are collected by the agent.

Class com.amazonaws.services.inspector.model.AssessmentRunFilter

class AssessmentRunFilter extends Object implements Serializable

Serialized Fields

completionTimeRange

TimestampRange completionTimeRange

For a record to match a filter, the value that is 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.

durationRange

DurationRange durationRange

For a record to match a filter, the value that is 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.

namePattern

String namePattern

For a record to match a filter, an explicit value or a string containing a wildcard that is specified for this data type property must match the value of the assessmentRunName property of the AssessmentRun data type.

rulesPackageArns

List<String> rulesPackageArns

For a record to match a filter, the value that is 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 that is 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.

stateChangeTimeRange

TimestampRange stateChangeTimeRange

For a record to match a filter, the value that is specified for this data type property must match the stateChangedAt property of the AssessmentRun data type.

states

List<String> 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.

Exception Class com.amazonaws.services.inspector.model.AssessmentRunInProgressException

class AssessmentRunInProgressException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

assessmentRunArns

List<String> assessmentRunArns

The ARNs of the assessment runs that are currently in progress.

assessmentRunArnsTruncated

Boolean assessmentRunArnsTruncated

Boolean value that indicates whether the ARN list of the assessment runs is truncated.

canRetry

Boolean canRetry

You can immediately retry your request.

Class com.amazonaws.services.inspector.model.AssessmentRunNotification

class AssessmentRunNotification extends Object implements Serializable

Serialized Fields

dateValue

Date dateValue

The date of the notification.

error

Boolean error

The Boolean value that specifies whether the notification represents an error.

event

String event

The event for which a notification is sent.

message

String message

snsPublishStatusCode

String snsPublishStatusCode

The status code of the SNS notification.

snsTopicArn

String snsTopicArn

The SNS topic to which the SNS notification is sent.

Class com.amazonaws.services.inspector.model.AssessmentRunStateChange

class AssessmentRunStateChange extends Object implements Serializable

Serialized Fields

state

String state

The assessment run state.

stateChangedAt

Date stateChangedAt

The last time the assessment run state changed.

Class com.amazonaws.services.inspector.model.AssessmentTarget

class AssessmentTarget extends Object implements Serializable

Serialized Fields

arn

String arn

The ARN that specifies the Amazon Inspector assessment target.

createdAt

Date createdAt

The time at which the assessment target is created.

name

String name

The name of the Amazon Inspector assessment target.

resourceGroupArn

String resourceGroupArn

The ARN that specifies the resource group that is associated with the assessment target.

updatedAt

Date updatedAt

The time at which UpdateAssessmentTarget is called.

Class com.amazonaws.services.inspector.model.AssessmentTargetFilter

class AssessmentTargetFilter extends Object implements Serializable

Serialized Fields

assessmentTargetNamePattern

String assessmentTargetNamePattern

For a record to match a filter, an explicit value or a string that contains a wildcard that is 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

class AssessmentTemplate extends Object implements Serializable

Serialized Fields

arn

String arn

The ARN of the assessment template.

assessmentTargetArn

String assessmentTargetArn

The ARN of the assessment target that corresponds to this assessment template.

createdAt

Date createdAt

The time at which the assessment template is created.

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

name

String name

The name of the assessment template.

rulesPackageArns

List<String> rulesPackageArns

The rules packages that are specified for this assessment template.

userAttributesForFindings

List<Attribute> userAttributesForFindings

The user-defined attributes that are assigned to every generated finding from the assessment run that uses this assessment template.

Class com.amazonaws.services.inspector.model.AssessmentTemplateFilter

class AssessmentTemplateFilter extends Object implements Serializable

Serialized Fields

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.

namePattern

String namePattern

For a record to match a filter, an explicit value or a string that contains a wildcard that is specified for this data type property must match the value of the assessmentTemplateName property of the AssessmentTemplate data type.

rulesPackageArns

List<String> rulesPackageArns

For a record to match a filter, the values that are 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

class AssetAttributes extends Object implements Serializable

Serialized Fields

agentId

String agentId

The ID of the agent that is installed on the EC2 instance where the finding is generated.

amiId

String amiId

The ID of the Amazon Machine Image (AMI) 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.

hostname

String hostname

The hostname of the EC2 instance where the finding is generated.

ipv4Addresses

List<String> ipv4Addresses

The list of IP v4 addresses of the EC2 instance where the finding is generated.

schemaVersion

Integer schemaVersion

The schema version of this data type.

Class com.amazonaws.services.inspector.model.Attribute

class 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

class CreateAssessmentTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTargetName

String assessmentTargetName

The user-defined name that identifies the assessment target that you want to create. The name must be unique within the AWS account.

resourceGroupArn

String resourceGroupArn

The ARN that specifies the resource group that is used to create the assessment target.

Class com.amazonaws.services.inspector.model.CreateAssessmentTargetResult

class CreateAssessmentTargetResult extends Object implements Serializable

Serialized Fields

assessmentTargetArn

String assessmentTargetArn

The ARN that specifies the assessment target that is created.

Class com.amazonaws.services.inspector.model.CreateAssessmentTemplateRequest

class CreateAssessmentTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTargetArn

String assessmentTargetArn

The ARN that specifies the assessment target for which you want to create the assessment template.

assessmentTemplateName

String assessmentTemplateName

The user-defined name that identifies the assessment template that you want to create. You can create several assessment templates for an assessment target. The names of the assessment templates that correspond 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<String> rulesPackageArns

The ARNs that specify the rules packages that you want to attach to the assessment template.

userAttributesForFindings

List<Attribute> userAttributesForFindings

The user-defined attributes that are assigned to every finding that is generated by the assessment run that uses this assessment template.

Class com.amazonaws.services.inspector.model.CreateAssessmentTemplateResult

class CreateAssessmentTemplateResult extends Object implements Serializable

Serialized Fields

assessmentTemplateArn

String assessmentTemplateArn

The ARN that specifies the assessment template that is created.

Class com.amazonaws.services.inspector.model.CreateResourceGroupRequest

class CreateResourceGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceGroupTags

List<ResourceGroupTag> 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

class CreateResourceGroupResult extends Object implements Serializable

Serialized Fields

resourceGroupArn

String resourceGroupArn

The ARN that specifies the resource group that is created.

Class com.amazonaws.services.inspector.model.DeleteAssessmentRunRequest

class DeleteAssessmentRunRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentRunArn

String assessmentRunArn

The ARN that specifies the assessment run that you want to delete.

Class com.amazonaws.services.inspector.model.DeleteAssessmentRunResult

class DeleteAssessmentRunResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.DeleteAssessmentTargetRequest

class DeleteAssessmentTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTargetArn

String assessmentTargetArn

The ARN that specifies the assessment target that you want to delete.

Class com.amazonaws.services.inspector.model.DeleteAssessmentTargetResult

class DeleteAssessmentTargetResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.DeleteAssessmentTemplateRequest

class DeleteAssessmentTemplateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTemplateArn

String assessmentTemplateArn

The ARN that specifies the assessment template that you want to delete.

Class com.amazonaws.services.inspector.model.DeleteAssessmentTemplateResult

class DeleteAssessmentTemplateResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.DescribeAssessmentRunsRequest

class DescribeAssessmentRunsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentRunArns

List<String> assessmentRunArns

The ARN that specifies the assessment run that you want to describe.

Class com.amazonaws.services.inspector.model.DescribeAssessmentRunsResult

class DescribeAssessmentRunsResult extends Object implements Serializable

Serialized Fields

assessmentRuns

List<AssessmentRun> assessmentRuns

Information about the assessment run.

failedItems

Map<String, FailedItemDetails> failedItems

Assessment run details that cannot be described. An error code is provided for each failed item.

Class com.amazonaws.services.inspector.model.DescribeAssessmentTargetsRequest

class DescribeAssessmentTargetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTargetArns

List<String> assessmentTargetArns

The ARNs that specifies the assessment targets that you want to describe.

Class com.amazonaws.services.inspector.model.DescribeAssessmentTargetsResult

class DescribeAssessmentTargetsResult extends Object implements Serializable

Serialized Fields

assessmentTargets

List<AssessmentTarget> assessmentTargets

Information about the assessment targets.

failedItems

Map<String, FailedItemDetails> failedItems

Assessment target details that cannot be described. An error code is provided for each failed item.

Class com.amazonaws.services.inspector.model.DescribeAssessmentTemplatesRequest

class DescribeAssessmentTemplatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTemplateArns

List<String> assessmentTemplateArns

The ARN that specifiesthe assessment templates that you want to describe.

Class com.amazonaws.services.inspector.model.DescribeAssessmentTemplatesResult

class DescribeAssessmentTemplatesResult extends Object implements Serializable

Serialized Fields

assessmentTemplates

List<AssessmentTemplate> assessmentTemplates

Information about the assessment templates.

failedItems

Map<String, FailedItemDetails> failedItems

Assessment template details that cannot be described. An error code is provided for each failed item.

Class com.amazonaws.services.inspector.model.DescribeCrossAccountAccessRoleRequest

class DescribeCrossAccountAccessRoleRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.inspector.model.DescribeCrossAccountAccessRoleResult

class DescribeCrossAccountAccessRoleResult extends Object implements Serializable

Serialized Fields

registeredAt

Date registeredAt

The date when the cross-account access role was registered.

roleArn

String roleArn

The ARN that specifies the IAM role that Amazon 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 Amazon Inspector to access your AWS account.

Class com.amazonaws.services.inspector.model.DescribeFindingsRequest

class DescribeFindingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

findingArns

List<String> findingArns

The ARN that specifies the finding that you want to describe.

locale

String locale

The locale into which you want to translate a finding description, recommendation, and the short description that identifies the finding.

Class com.amazonaws.services.inspector.model.DescribeFindingsResult

class DescribeFindingsResult extends Object implements Serializable

Serialized Fields

failedItems

Map<String, FailedItemDetails> failedItems

Finding details that cannot be described. An error code is provided for each failed item.

findings

List<Finding> findings

Information about the finding.

Class com.amazonaws.services.inspector.model.DescribeResourceGroupsRequest

class DescribeResourceGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceGroupArns

List<String> resourceGroupArns

The ARN that specifies the resource group that you want to describe.

Class com.amazonaws.services.inspector.model.DescribeResourceGroupsResult

class DescribeResourceGroupsResult extends Object implements Serializable

Serialized Fields

failedItems

Map<String, FailedItemDetails> failedItems

Resource group details that cannot be described. An error code is provided for each failed item.

resourceGroups

List<ResourceGroup> resourceGroups

Information about a resource group.

Class com.amazonaws.services.inspector.model.DescribeRulesPackagesRequest

class DescribeRulesPackagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

locale

String locale

The locale that you want to translate a rules package description into.

rulesPackageArns

List<String> rulesPackageArns

The ARN that specifies the rules package that you want to describe.

Class com.amazonaws.services.inspector.model.DescribeRulesPackagesResult

class DescribeRulesPackagesResult extends Object implements Serializable

Serialized Fields

failedItems

Map<String, FailedItemDetails> failedItems

Rules package details that cannot be described. An error code is provided for each failed item.

rulesPackages

List<RulesPackage> rulesPackages

Information about the rules package.

Class com.amazonaws.services.inspector.model.DurationRange

class DurationRange extends Object implements Serializable

Serialized Fields

maxSeconds

Integer maxSeconds

The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).

minSeconds

Integer minSeconds

The minimum value of the duration range. Must be greater than zero.

Class com.amazonaws.services.inspector.model.EventSubscription

class 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 SubscribeToEvent is called.

Class com.amazonaws.services.inspector.model.FailedItemDetails

class 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

class Finding extends Object implements Serializable

Serialized Fields

arn

String arn

The ARN that specifies the finding.

assetAttributes

AssetAttributes assetAttributes

A collection of attributes of the host from which the finding is generated.

assetType

String assetType

The type of the host from which the finding is generated.

attributes

List<Attribute> attributes

The system-defined attributes for the finding.

confidence

Integer confidence

This data element is currently not used.

createdAt

Date createdAt

The time when the finding was generated.

description

String description

The description of the finding.

id

String id

The ID of the finding.

indicatorOfCompromise

Boolean indicatorOfCompromise

This data element is currently not used.

numericSeverity

Double numericSeverity

The numeric value of the finding severity.

recommendation

String recommendation

The recommendation for 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

severity

String severity

The finding severity. Values can be set to High, Medium, Low, and Informational.

title

String title

The name of the finding.

updatedAt

Date updatedAt

The time when AddAttributesToFindings is called.

userAttributes

List<Attribute> userAttributes

The user-defined attributes that are assigned to the finding.

Class com.amazonaws.services.inspector.model.FindingFilter

class FindingFilter extends Object implements Serializable

Serialized Fields

agentIds

List<String> agentIds

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the agentId property of the Finding data type.

attributes

List<Attribute> attributes

For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the attributes property of the Finding data type.

autoScalingGroups

List<String> autoScalingGroups

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the autoScalingGroup property of the Finding data type.

creationTimeRange

TimestampRange creationTimeRange

The time range during which the finding is generated.

ruleNames

List<String> ruleNames

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.

rulesPackageArns

List<String> rulesPackageArns

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.

severities

List<String> severities

For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the severity property of the Finding data type.

userAttributes

List<Attribute> userAttributes

For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the userAttributes property of the Finding data type.

Class com.amazonaws.services.inspector.model.GetTelemetryMetadataRequest

class GetTelemetryMetadataRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentRunArn

String assessmentRunArn

The ARN that specifies the assessment run that has the telemetry data that you want to obtain.

Class com.amazonaws.services.inspector.model.GetTelemetryMetadataResult

class GetTelemetryMetadataResult extends Object implements Serializable

Serialized Fields

telemetryMetadata

List<TelemetryMetadata> telemetryMetadata

Telemetry details.

Class com.amazonaws.services.inspector.model.InspectorServiceAttributes

class InspectorServiceAttributes extends Object implements Serializable

Serialized Fields

assessmentRunArn

String assessmentRunArn

The ARN of the assessment run during which the finding is generated.

rulesPackageArn

String rulesPackageArn

The ARN of the rules package that is used to generate the finding.

schemaVersion

Integer schemaVersion

The schema version of this data type.

Exception Class com.amazonaws.services.inspector.model.InternalException

class InternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

canRetry

Boolean canRetry

You can immediately retry your request.

Exception Class com.amazonaws.services.inspector.model.InvalidCrossAccountRoleException

class InvalidCrossAccountRoleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

canRetry

Boolean canRetry

You can immediately retry your request.

errorCode

String errorCode

Code that indicates the type of error that is generated.

Exception Class com.amazonaws.services.inspector.model.InvalidInputException

class InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

canRetry

Boolean canRetry

You can immediately retry your request.

errorCode

String errorCode

Code that indicates the type of error that is generated.

Exception Class com.amazonaws.services.inspector.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

canRetry

Boolean canRetry

You can immediately retry your request.

errorCode

String errorCode

Code that indicates the type of error that is generated.

Class com.amazonaws.services.inspector.model.ListAssessmentRunAgentsRequest

class ListAssessmentRunAgentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentRunArn

String assessmentRunArn

The ARN that specifies 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.

maxResults

Integer maxResults

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

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 the previous response to continue listing data.

Class com.amazonaws.services.inspector.model.ListAssessmentRunAgentsResult

class ListAssessmentRunAgentsResult extends Object implements Serializable

Serialized Fields

assessmentRunAgents

List<AssessmentRunAgent> assessmentRunAgents

A list of ARNs that specifies 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

class ListAssessmentRunsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTemplateArns

List<String> assessmentTemplateArns

The ARNs that specify the assessment templates whose assessment runs 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.

maxResults

Integer maxResults

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 10. The maximum value is 500.

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 the previous response to continue listing data.

Class com.amazonaws.services.inspector.model.ListAssessmentRunsResult

class ListAssessmentRunsResult extends Object implements Serializable

Serialized Fields

assessmentRunArns

List<String> assessmentRunArns

A list of ARNs that specifies the assessment runs that are 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

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

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.

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 the previous response to continue listing data.

Class com.amazonaws.services.inspector.model.ListAssessmentTargetsResult

class ListAssessmentTargetsResult extends Object implements Serializable

Serialized Fields

assessmentTargetArns

List<String> assessmentTargetArns

A list of ARNs that specifies the assessment targets that are 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

class ListAssessmentTemplatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentTargetArns

List<String> assessmentTargetArns

A list of ARNs that specifies the assessment targets whose assessment templates 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.

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.

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 the previous response to continue listing data.

Class com.amazonaws.services.inspector.model.ListAssessmentTemplatesResult

class ListAssessmentTemplatesResult extends Object implements Serializable

Serialized Fields

assessmentTemplateArns

List<String> assessmentTemplateArns

A list of ARNs that specifies the assessment templates 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

class ListEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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 the previous response to continue listing data.

resourceArn

String resourceArn

The ARN of the assessment template for which you want to list the existing event subscriptions.

Class com.amazonaws.services.inspector.model.ListEventSubscriptionsResult

class ListEventSubscriptionsResult extends Object implements Serializable

Serialized Fields

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.

subscriptions

List<Subscription> subscriptions

Details of the returned event subscriptions.

Class com.amazonaws.services.inspector.model.ListFindingsRequest

class ListFindingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentRunArns

List<String> assessmentRunArns

The ARNs of the assessment runs 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.

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.

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 the previous response to continue listing data.

Class com.amazonaws.services.inspector.model.ListFindingsResult

class ListFindingsResult extends Object implements Serializable

Serialized Fields

findingArns

List<String> findingArns

A list of ARNs that specifies the findings 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

class ListRulesPackagesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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 the previous response to continue listing data.

Class com.amazonaws.services.inspector.model.ListRulesPackagesResult

class ListRulesPackagesResult extends Object implements Serializable

Serialized Fields

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.

rulesPackageArns

List<String> rulesPackageArns

The list of ARNs that specifies the rules packages returned by the action.

Class com.amazonaws.services.inspector.model.ListTagsForResourceRequest

class ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceArn

String resourceArn

The ARN that specifies the assessment template whose tags you want to list.

Class com.amazonaws.services.inspector.model.ListTagsForResourceResult

class ListTagsForResourceResult extends Object implements Serializable

Serialized Fields

tags

List<Tag> tags

A collection of key and value pairs.

Exception Class com.amazonaws.services.inspector.model.NoSuchEntityException

class NoSuchEntityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

canRetry

Boolean canRetry

You can immediately retry your request.

errorCode

String errorCode

Code that indicates the type of error that is generated.

Class com.amazonaws.services.inspector.model.PreviewAgentsRequest

class PreviewAgentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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 the previous response to continue listing data.

previewAgentsArn

String previewAgentsArn

The ARN of the assessment target whose agents you want to preview.

Class com.amazonaws.services.inspector.model.PreviewAgentsResult

class PreviewAgentsResult extends Object implements Serializable

Serialized Fields

agentPreviews

List<AgentPreview> 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

class RegisterCrossAccountAccessRoleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

roleArn

String roleArn

The ARN of the IAM role that Amazon Inspector uses to list your EC2 instances during the assessment run or when you call the PreviewAgents action.

Class com.amazonaws.services.inspector.model.RegisterCrossAccountAccessRoleResult

class RegisterCrossAccountAccessRoleResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.RemoveAttributesFromFindingsRequest

class RemoveAttributesFromFindingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeKeys

List<String> attributeKeys

The array of attribute keys that you want to remove from specified findings.

findingArns

List<String> findingArns

The ARNs that specify the findings that you want to remove attributes from.

Class com.amazonaws.services.inspector.model.RemoveAttributesFromFindingsResult

class RemoveAttributesFromFindingsResult extends Object implements Serializable

Serialized Fields

failedItems

Map<String, FailedItemDetails> failedItems

Attributes details that cannot be described. An error code is provided for each failed item.

Class com.amazonaws.services.inspector.model.ResourceGroup

class ResourceGroup extends Object implements Serializable

Serialized Fields

arn

String arn

The ARN of the resource group.

createdAt

Date createdAt

The time at which resource group is created.

tags

List<ResourceGroupTag> tags

The tags (key and value pairs) of the resource group. This data type property is used in the CreateResourceGroup action.

Class com.amazonaws.services.inspector.model.ResourceGroupTag

class 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

class RulesPackage extends Object implements Serializable

Serialized Fields

arn

String arn

The ARN of the rules package.

description

String description

The description of the rules package.

name

String name

The name of the rules package.

provider

String provider

The provider of the rules package.

version

String version

The version ID of the rules package.

Class com.amazonaws.services.inspector.model.SetTagsForResourceRequest

class 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<Tag> tags

A collection of key and value pairs that you want to set to the assessment template.

Class com.amazonaws.services.inspector.model.SetTagsForResourceResult

class SetTagsForResourceResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.StartAssessmentRunRequest

class StartAssessmentRunRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

assessmentRunName

String assessmentRunName

You can specify the name for the assessment run, or you can use the auto-generated name that is based on the assessment template name. The name must be unique for the assessment template.

assessmentTemplateArn

String assessmentTemplateArn

The ARN of the assessment template of the assessment run that you want to start.

Class com.amazonaws.services.inspector.model.StartAssessmentRunResult

class 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

class 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.StopAssessmentRunResult

class StopAssessmentRunResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.SubscribeToEventRequest

class SubscribeToEventRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

event

String event

The event for which you want to receive SNS notifications.

resourceArn

String resourceArn

The ARN of the assessment template that is used during 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.SubscribeToEventResult

class SubscribeToEventResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.Subscription

class Subscription extends Object implements Serializable

Serialized Fields

eventSubscriptions

List<EventSubscription> eventSubscriptions

The list of existing event subscriptions.

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.

Class com.amazonaws.services.inspector.model.Tag

class 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

class TelemetryMetadata extends Object implements Serializable

Serialized Fields

count

Long count

The count of messages that the agent sends to the Amazon Inspector service.

dataSize

Long dataSize

The data size of messages that the agent sends to the Amazon Inspector service.

messageType

String messageType

A specific type of behavioral data that is collected by the agent.

Class com.amazonaws.services.inspector.model.TimestampRange

class 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

class UnsubscribeFromEventRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

event

String event

The event for which you want to stop receiving SNS notifications.

resourceArn

String resourceArn

The ARN of the assessment template that is used during 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.UnsubscribeFromEventResult

class UnsubscribeFromEventResult extends Object implements Serializable

Class com.amazonaws.services.inspector.model.UpdateAssessmentTargetRequest

class 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 ARN of the resource group that is used to specify the new resource group to associate with the assessment target.

Class com.amazonaws.services.inspector.model.UpdateAssessmentTargetResult

class UpdateAssessmentTargetResult extends Object implements Serializable

Package com.amazonaws.services.iot.model

Class com.amazonaws.services.iot.model.AcceptCertificateTransferRequest

class 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.AcceptCertificateTransferResult

class AcceptCertificateTransferResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.Action

class Action extends Object implements Serializable

Serialized Fields

cloudwatchAlarm

CloudwatchAlarmAction cloudwatchAlarm

Change the state of a CloudWatch alarm.

cloudwatchMetric

CloudwatchMetricAction cloudwatchMetric

Capture a CloudWatch metric.

dynamoDB

DynamoDBAction dynamoDB

Write to a DynamoDB table.

elasticsearch

ElasticsearchAction elasticsearch

Write data to an Amazon Elasticsearch Service; domain.

firehose

FirehoseAction firehose

Write to an Amazon Kinesis Firehose stream.

kinesis

KinesisAction kinesis

Write data to an Amazon Kinesis stream.

lambda

LambdaAction lambda

Invoke a Lambda function.

republish

RepublishAction republish

Publish to another MQTT topic.

s3

S3Action s3

Write to an Amazon S3 bucket.

sns

SnsAction sns

Publish to an Amazon SNS topic.

sqs

SqsAction sqs

Publish to an Amazon SQS queue.

Class com.amazonaws.services.iot.model.AttachPrincipalPolicyRequest

class 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.AttachPrincipalPolicyResult

class AttachPrincipalPolicyResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.AttachThingPrincipalRequest

class AttachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

principal

String principal

The principal (certificate or other credential).

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iot.model.AttachThingPrincipalResult

class AttachThingPrincipalResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.AttributePayload

class AttributePayload extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> 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

class CACertificate extends Object implements Serializable

Serialized Fields

certificateArn

String certificateArn

The ARN of the CA certificate.

certificateId

String certificateId

The ID of the CA certificate.

creationDate

Date creationDate

The date the CA certificate was created.

status

String status

The status of the CA certificate.

Class com.amazonaws.services.iot.model.CACertificateDescription

class CACertificateDescription extends Object implements Serializable

Serialized Fields

certificateArn

String certificateArn

The CA certificate ARN.

certificateId

String certificateId

The CA certificate ID.

certificatePem

String certificatePem

The CA certificate data, in PEM format.

creationDate

Date creationDate

The date the CA certificate was created.

ownedBy

String ownedBy

The owner of the CA certificate.

status

String status

The status of a CA certificate.

Class com.amazonaws.services.iot.model.CancelCertificateTransferRequest

class CancelCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the certificate.

Class com.amazonaws.services.iot.model.CancelCertificateTransferResult

class CancelCertificateTransferResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.Certificate

class Certificate extends Object implements Serializable

Serialized Fields

certificateArn

String certificateArn

The ARN of the certificate.

certificateId

String certificateId

The ID of the certificate.

creationDate

Date creationDate

The date and time the certificate was created.

status

String status

The status of the certificate.

Exception Class com.amazonaws.services.iot.model.CertificateConflictException

class CertificateConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.CertificateDescription

class CertificateDescription extends Object implements Serializable

Serialized Fields

caCertificateId

String caCertificateId

The certificate ID of the CA certificate used to sign this certificate.

certificateArn

String certificateArn

The ARN of the certificate.

certificateId

String certificateId

The ID of the certificate.

certificatePem

String certificatePem

The certificate data, in PEM format.

creationDate

Date creationDate

The date and time the certificate was created.

lastModifiedDate

Date lastModifiedDate

The date and time the certificate was last modified.

ownedBy

String ownedBy

The ID of the AWS account that owns the certificate.

previousOwnedBy

String previousOwnedBy

The ID of the AWS account of the previous owner of the certificate.

status

String status

The status of the certificate.

transferData

TransferData transferData

The transfer data.

Exception Class com.amazonaws.services.iot.model.CertificateStateException

class CertificateStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iot.model.CertificateValidationException

class CertificateValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.CloudwatchAlarmAction

class CloudwatchAlarmAction extends Object implements Serializable

Serialized Fields

alarmName

String alarmName

The CloudWatch alarm name.

roleArn

String roleArn

The IAM role that allows access to the CloudWatch alarm.

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

class CloudwatchMetricAction extends Object implements Serializable

Serialized Fields

metricName

String metricName

The CloudWatch metric name.

metricNamespace

String metricNamespace

The CloudWatch metric namespace name.

metricTimestamp

String metricTimestamp

An optional Unix timestamp.

metricUnit

String metricUnit

The metric unit supported by CloudWatch.

metricValue

String metricValue

The CloudWatch metric value.

roleArn

String roleArn

The IAM role that allows access to the CloudWatch metric.

Class com.amazonaws.services.iot.model.CreateCertificateFromCsrRequest

class 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

class 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

class CreateKeysAndCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

setAsActive

Boolean setAsActive

Specifies whether the certificate is active.

Class com.amazonaws.services.iot.model.CreateKeysAndCertificateResult

class 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

class CreatePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

policyName

String policyName

The policy name.

Class com.amazonaws.services.iot.model.CreatePolicyResult

class CreatePolicyResult extends Object implements Serializable

Serialized Fields

policyArn

String policyArn

The policy ARN.

policyDocument

String policyDocument

The JSON document that describes the policy.

policyName

String policyName

The policy name.

policyVersionId

String policyVersionId

The policy version ID.

Class com.amazonaws.services.iot.model.CreatePolicyVersionRequest

class CreatePolicyVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyDocument

String policyDocument

The JSON document that describes the policy. Minimum length of 1. Maximum length of 2048, excluding whitespaces

policyName

String policyName

The policy name.

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

class CreatePolicyVersionResult extends Object implements Serializable

Serialized Fields

isDefaultVersion

Boolean isDefaultVersion

Specifies whether the policy version is the default.

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

class CreateThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributePayload

AttributePayload attributePayload

The attribute payload, which consists of up to 3 name/value pairs in a JSON document (for example, {\"attributes\":{\"string1\":\"string2\"}}).

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iot.model.CreateThingResult

class CreateThingResult extends Object implements Serializable

Serialized Fields

thingArn

String thingArn

The thing ARN.

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iot.model.CreateTopicRuleRequest

class 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.CreateTopicRuleResult

class CreateTopicRuleResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteCACertificateRequest

class DeleteCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the certificate to delete.

Class com.amazonaws.services.iot.model.DeleteCACertificateResult

class DeleteCACertificateResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteCertificateRequest

class DeleteCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the certificate.

Class com.amazonaws.services.iot.model.DeleteCertificateResult

class DeleteCertificateResult extends Object implements Serializable

Exception Class com.amazonaws.services.iot.model.DeleteConflictException

class DeleteConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.DeletePolicyRequest

class DeletePolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the policy to delete.

Class com.amazonaws.services.iot.model.DeletePolicyResult

class DeletePolicyResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DeletePolicyVersionRequest

class 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.DeletePolicyVersionResult

class DeletePolicyVersionResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteRegistrationCodeRequest

class DeleteRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.DeleteRegistrationCodeResult

class DeleteRegistrationCodeResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteThingRequest

class DeleteThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingName

String thingName

The thing name.

Class com.amazonaws.services.iot.model.DeleteThingResult

class DeleteThingResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DeleteTopicRuleRequest

class DeleteTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

String ruleName

The name of the rule.

Class com.amazonaws.services.iot.model.DeleteTopicRuleResult

class DeleteTopicRuleResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DescribeCACertificateRequest

class DescribeCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The CA certificate identifier.

Class com.amazonaws.services.iot.model.DescribeCACertificateResult

class DescribeCACertificateResult extends Object implements Serializable

Serialized Fields

certificateDescription

CACertificateDescription certificateDescription

The CA certificate description.

Class com.amazonaws.services.iot.model.DescribeCertificateRequest

class DescribeCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the certificate.

Class com.amazonaws.services.iot.model.DescribeCertificateResult

class DescribeCertificateResult extends Object implements Serializable

Serialized Fields

certificateDescription

CertificateDescription certificateDescription

The description of the certificate.

Class com.amazonaws.services.iot.model.DescribeEndpointRequest

class DescribeEndpointRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.DescribeEndpointResult

class 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

class DescribeThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iot.model.DescribeThingResult

class DescribeThingResult extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> 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\"}})

defaultClientId

String defaultClientId

The default client ID.

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iot.model.DetachPrincipalPolicyRequest

class 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.DetachPrincipalPolicyResult

class DetachPrincipalPolicyResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DetachThingPrincipalRequest

class DetachThingPrincipalRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

principal

String principal

The principal.

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iot.model.DetachThingPrincipalResult

class DetachThingPrincipalResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DisableTopicRuleRequest

class DisableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

String ruleName

The name of the rule to disable.

Class com.amazonaws.services.iot.model.DisableTopicRuleResult

class DisableTopicRuleResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.DynamoDBAction

class DynamoDBAction extends Object implements Serializable

Serialized Fields

hashKeyField

String hashKeyField

The hash key name.

hashKeyValue

String hashKeyValue

The hash key value.

payloadField

String payloadField

The action payload. This name can be customized.

rangeKeyField

String rangeKeyField

The range key name.

rangeKeyValue

String rangeKeyValue

The range key value.

roleArn

String roleArn

The ARN of the IAM role that grants access to the DynamoDB table.

tableName

String tableName

The name of the DynamoDB table.

Class com.amazonaws.services.iot.model.ElasticsearchAction

class ElasticsearchAction extends Object implements Serializable

Serialized Fields

endpoint

String endpoint

The endpoint of your Elasticsearch domain.

id

String id

The unique identifier for the document you are storing.

index

String index

The Elasticsearch index where you want to store your data.

roleArn

String roleArn

The IAM role ARN that has access to Elasticsearch.

type

String type

The type of document you are storing.

Class com.amazonaws.services.iot.model.EnableTopicRuleRequest

class EnableTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

String ruleName

The name of the topic rule to enable.

Class com.amazonaws.services.iot.model.EnableTopicRuleResult

class EnableTopicRuleResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.FirehoseAction

class FirehoseAction extends Object implements Serializable

Serialized Fields

deliveryStreamName

String deliveryStreamName

The delivery stream name.

roleArn

String roleArn

The IAM role that grants access to the Amazon Kinesis Firehost stream.

Class com.amazonaws.services.iot.model.GetLoggingOptionsRequest

class GetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.GetLoggingOptionsResult

class GetLoggingOptionsResult extends Object implements Serializable

Serialized Fields

logLevel

String logLevel

The logging level.

roleArn

String roleArn

The ARN of the IAM role that grants access.

Class com.amazonaws.services.iot.model.GetPolicyRequest

class GetPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the policy.

Class com.amazonaws.services.iot.model.GetPolicyResult

class GetPolicyResult extends Object implements Serializable

Serialized Fields

defaultVersionId

String defaultVersionId

The default policy version ID.

policyArn

String policyArn

The policy ARN.

policyDocument

String policyDocument

The JSON document that describes the policy.

policyName

String policyName

The policy name.

Class com.amazonaws.services.iot.model.GetPolicyVersionRequest

class 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

class GetPolicyVersionResult extends Object implements Serializable

Serialized Fields

isDefaultVersion

Boolean isDefaultVersion

Specifies whether the policy version is the default.

policyArn

String policyArn

The policy ARN.

policyDocument

String policyDocument

The JSON document that describes the policy.

policyName

String policyName

The policy name.

policyVersionId

String policyVersionId

The policy version ID.

Class com.amazonaws.services.iot.model.GetRegistrationCodeRequest

class GetRegistrationCodeRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.iot.model.GetRegistrationCodeResult

class GetRegistrationCodeResult extends Object implements Serializable

Serialized Fields

registrationCode

String registrationCode

The CA certificate registration code.

Class com.amazonaws.services.iot.model.GetTopicRuleRequest

class GetTopicRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleName

String ruleName

The name of the rule.

Class com.amazonaws.services.iot.model.GetTopicRuleResult

class GetTopicRuleResult extends Object implements Serializable

Serialized Fields

rule

TopicRule rule

The rule.

ruleArn

String ruleArn

The rule ARN.

Exception Class com.amazonaws.services.iot.model.InternalException

class InternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iot.model.InternalFailureException

class InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iot.model.InvalidRequestException

class InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.KeyPair

class KeyPair extends Object implements Serializable

Serialized Fields

privateKey

String privateKey

The private key.

publicKey

String publicKey

The public key.

Class com.amazonaws.services.iot.model.KinesisAction

class KinesisAction extends Object implements Serializable

Serialized Fields

partitionKey

String partitionKey

The partition key.

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.

Class com.amazonaws.services.iot.model.LambdaAction

class LambdaAction extends Object implements Serializable

Serialized Fields

functionArn

String functionArn

The ARN of the Lambda function.

Exception Class com.amazonaws.services.iot.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.ListCACertificatesRequest

class ListCACertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

Boolean ascendingOrder

Determines the order of the results.

marker

String marker

The marker for the next set of results.

pageSize

Integer pageSize

The result page size.

Class com.amazonaws.services.iot.model.ListCACertificatesResult

class ListCACertificatesResult extends Object implements Serializable

Serialized Fields

certificates

List<CACertificate> certificates

The CA certificates registered in your AWS account.

nextMarker

String nextMarker

The current position within the list of CA certificates.

Class com.amazonaws.services.iot.model.ListCertificatesByCARequest

class ListCertificatesByCARequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

Boolean ascendingOrder

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

caCertificateId

String caCertificateId

The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

marker

String marker

The marker for the next set of results.

pageSize

Integer pageSize

The result page size.

Class com.amazonaws.services.iot.model.ListCertificatesByCAResult

class ListCertificatesByCAResult extends Object implements Serializable

Serialized Fields

certificates

List<Certificate> certificates

The device certificates signed by the specified CA certificate.

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

class ListCertificatesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

Boolean ascendingOrder

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

marker

String marker

The marker for the next set of results.

pageSize

Integer pageSize

The result page size.

Class com.amazonaws.services.iot.model.ListCertificatesResult

class ListCertificatesResult extends Object implements Serializable

Serialized Fields

certificates

List<Certificate> 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

class ListPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

Boolean ascendingOrder

Specifies the order for results. If true, the results are returned in ascending creation order.

marker

String marker

The marker for the next set of results.

pageSize

Integer pageSize

The result page size.

Class com.amazonaws.services.iot.model.ListPoliciesResult

class ListPoliciesResult extends Object implements Serializable

Serialized Fields

nextMarker

String nextMarker

The marker for the next set of results, or null if there are no additional results.

policies

List<Policy> policies

The descriptions of the policies.

Class com.amazonaws.services.iot.model.ListPolicyVersionsRequest

class ListPolicyVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The policy name.

Class com.amazonaws.services.iot.model.ListPolicyVersionsResult

class ListPolicyVersionsResult extends Object implements Serializable

Serialized Fields

policyVersions

List<PolicyVersion> policyVersions

The policy versions.

Class com.amazonaws.services.iot.model.ListPrincipalPoliciesRequest

class ListPrincipalPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ascendingOrder

Boolean ascendingOrder

Specifies the order for results. If true, results are returned in ascending creation order.

marker

String marker

The marker for the next set of results.

pageSize

Integer pageSize

The result page size.

principal

String principal

The principal.

Class com.amazonaws.services.iot.model.ListPrincipalPoliciesResult

class ListPrincipalPoliciesResult extends Object implements Serializable

Serialized Fields

nextMarker

String nextMarker

The marker for the next set of results, or null if there are no additional results.

policies

List<Policy> policies

The policies.

Class com.amazonaws.services.iot.model.ListPrincipalThingsRequest

class ListPrincipalThingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

maxResults

Integer maxResults

The maximum number of principals to return.

nextToken

String nextToken

A token used to retrieve the next value.

principal

String principal

The principal.

Class com.amazonaws.services.iot.model.ListPrincipalThingsResult

class ListPrincipalThingsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

A token used to retrieve the next value.

things

List<String> things

The things.

Class com.amazonaws.services.iot.model.ListThingPrincipalsRequest

class ListThingPrincipalsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iot.model.ListThingPrincipalsResult

class ListThingPrincipalsResult extends Object implements Serializable

Serialized Fields

principals

List<String> principals

The principals.

Class com.amazonaws.services.iot.model.ListThingsRequest

class ListThingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributeName

String attributeName

The attribute name.

attributeValue

String attributeValue

The attribute value.

maxResults

Integer maxResults

The maximum number of results.

nextToken

String nextToken

The token for the next value.

Class com.amazonaws.services.iot.model.ListThingsResult

class ListThingsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

A token used to retrieve the next value.

things

List<ThingAttribute> things

The things.

Class com.amazonaws.services.iot.model.ListTopicRulesRequest

class ListTopicRulesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

topic

String topic

The topic.

Class com.amazonaws.services.iot.model.ListTopicRulesResult

class ListTopicRulesResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

A token used to retrieve the next value.

rules

List<TopicRuleListItem> rules

The rules.

Class com.amazonaws.services.iot.model.LoggingOptionsPayload

class LoggingOptionsPayload extends Object implements Serializable

Serialized Fields

logLevel

String logLevel

The logging level.

roleArn

String roleArn

The ARN of the IAM role that grants access.

Exception Class com.amazonaws.services.iot.model.MalformedPolicyException

class MalformedPolicyException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.Policy

class Policy extends Object implements Serializable

Serialized Fields

policyArn

String policyArn

The policy ARN.

policyName

String policyName

The policy name.

Class com.amazonaws.services.iot.model.PolicyVersion

class PolicyVersion extends Object implements Serializable

Serialized Fields

createDate

Date createDate

The date and time the policy was created.

isDefaultVersion

Boolean isDefaultVersion

Specifies whether the policy version is the default.

versionId

String versionId

The policy version ID.

Class com.amazonaws.services.iot.model.RegisterCACertificateRequest

class RegisterCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

caCertificate

String caCertificate

The CA certificate.

setAsActive

Boolean setAsActive

A boolean value that specifies if the CA certificate is set to active.

verificationCertificate

String verificationCertificate

The private key verification certificate.

Class com.amazonaws.services.iot.model.RegisterCACertificateResult

class RegisterCACertificateResult extends Object implements Serializable

Serialized Fields

certificateArn

String certificateArn

The CA certificate ARN.

certificateId

String certificateId

The CA certificate identifier.

Class com.amazonaws.services.iot.model.RegisterCertificateRequest

class RegisterCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

caCertificatePem

String caCertificatePem

The CA certificate used to sign the device certificate being registered.

certificatePem

String certificatePem

The certificate data, in PEM format.

setAsActive

Boolean setAsActive

A boolean value that specifies if the CA certificate is set to active.

Class com.amazonaws.services.iot.model.RegisterCertificateResult

class RegisterCertificateResult extends Object implements Serializable

Serialized Fields

certificateArn

String certificateArn

The certificate ARN.

certificateId

String certificateId

The certificate identifier.

Exception Class com.amazonaws.services.iot.model.RegistrationCodeValidationException

class RegistrationCodeValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.RejectCertificateTransferRequest

class RejectCertificateTransferRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the certificate.

rejectReason

String rejectReason

The reason the certificate transfer was rejected.

Class com.amazonaws.services.iot.model.RejectCertificateTransferResult

class RejectCertificateTransferResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.ReplaceTopicRuleRequest

class 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.ReplaceTopicRuleResult

class ReplaceTopicRuleResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.RepublishAction

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

Exception Class com.amazonaws.services.iot.model.ResourceAlreadyExistsException

class ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iot.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.S3Action

class S3Action extends Object implements Serializable

Serialized Fields

bucketName

String bucketName

The Amazon S3 bucket.

key

String key

The object key.

roleArn

String roleArn

The ARN of the IAM role that grants access.

Exception Class com.amazonaws.services.iot.model.ServiceUnavailableException

class ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.SetDefaultPolicyVersionRequest

class 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.SetDefaultPolicyVersionResult

class SetDefaultPolicyVersionResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.SetLoggingOptionsRequest

class SetLoggingOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

loggingOptionsPayload

LoggingOptionsPayload loggingOptionsPayload

The logging options payload.

Class com.amazonaws.services.iot.model.SetLoggingOptionsResult

class SetLoggingOptionsResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.SnsAction

class SnsAction extends Object implements Serializable

Serialized Fields

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.

roleArn

String roleArn

The ARN of the IAM role that grants access.

targetArn

String targetArn

The ARN of the SNS topic.

Exception Class com.amazonaws.services.iot.model.SqlParseException

class SqlParseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.SqsAction

class SqsAction extends Object implements Serializable

Serialized Fields

queueUrl

String queueUrl

The URL of the Amazon SQS queue.

roleArn

String roleArn

The ARN of the IAM role that grants access.

useBase64

Boolean useBase64

Specifies whether to use Base64 encoding.

Class com.amazonaws.services.iot.model.ThingAttribute

class ThingAttribute extends Object implements Serializable

Serialized Fields

attributes

Map<String,String> attributes

The attributes.

thingName

String thingName

The name of the thing.

Exception Class com.amazonaws.services.iot.model.ThrottlingException

class ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.TopicRule

class TopicRule extends Object implements Serializable

Serialized Fields

actions

List<Action> actions

The actions associated with the rule.

awsIotSqlVersion

String awsIotSqlVersion

The version of the SQL rules engine to use when evaluating the rule.

createdAt

Date createdAt

The date and time the rule was created.

description

String description

The description of the rule.

ruleDisabled

Boolean ruleDisabled

Specifies whether the rule is disabled.

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.

Class com.amazonaws.services.iot.model.TopicRuleListItem

class TopicRuleListItem extends Object implements Serializable

Serialized Fields

createdAt

Date createdAt

The date and time the rule was created.

ruleArn

String ruleArn

The rule ARN.

ruleDisabled

Boolean ruleDisabled

Specifies whether the rule is disabled.

ruleName

String ruleName

The name of the rule.

topicPattern

String topicPattern

The pattern for the topic names that apply.

Class com.amazonaws.services.iot.model.TopicRulePayload

class TopicRulePayload extends Object implements Serializable

Serialized Fields

actions

List<Action> actions

The actions associated with the rule.

awsIotSqlVersion

String awsIotSqlVersion

The version of the SQL rules engine to use when evaluating the rule.

description

String description

The description of the rule.

ruleDisabled

Boolean ruleDisabled

Specifies whether the rule is disabled.

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.

Exception Class com.amazonaws.services.iot.model.TransferAlreadyCompletedException

class TransferAlreadyCompletedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.TransferCertificateRequest

class TransferCertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The ID of the certificate.

targetAwsAccount

String targetAwsAccount

The AWS account.

transferMessage

String transferMessage

The transfer message.

Class com.amazonaws.services.iot.model.TransferCertificateResult

class TransferCertificateResult extends Object implements Serializable

Serialized Fields

transferredCertificateArn

String transferredCertificateArn

The ARN of the certificate.

Exception Class com.amazonaws.services.iot.model.TransferConflictException

class TransferConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.TransferData

class TransferData extends Object implements Serializable

Serialized Fields

acceptDate

Date acceptDate

The date the transfer was accepted.

rejectDate

Date rejectDate

The date the transfer was rejected.

rejectReason

String rejectReason

The reason why the transfer was rejected.

transferDate

Date transferDate

The date the transfer took place.

transferMessage

String transferMessage

The transfer message.

Exception Class com.amazonaws.services.iot.model.UnauthorizedException

class UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iot.model.UpdateCACertificateRequest

class UpdateCACertificateRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

certificateId

String certificateId

The CA certificate identifier.

newStatus

String newStatus

The updated status of the CA certificate.

Class com.amazonaws.services.iot.model.UpdateCACertificateResult

class UpdateCACertificateResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateCertificateRequest

class 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.UpdateCertificateResult

class UpdateCertificateResult extends Object implements Serializable

Class com.amazonaws.services.iot.model.UpdateThingRequest

class UpdateThingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributePayload

AttributePayload attributePayload

The attribute payload, a JSON string containing up to three key-value pairs (for example, {\"attributes\":{\"string1\":\"string2\"}}).

thingName

String thingName

The thing name.

Class com.amazonaws.services.iot.model.UpdateThingResult

class UpdateThingResult extends Object implements Serializable

Exception Class com.amazonaws.services.iot.model.VersionsLimitExceededException

class VersionsLimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.iotdata.model

Exception Class com.amazonaws.services.iotdata.model.ConflictException

class ConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.DeleteThingShadowRequest

class DeleteThingShadowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iotdata.model.DeleteThingShadowResult

class DeleteThingShadowResult extends Object implements Serializable

Serialized Fields

payload

ByteBuffer payload

The state information, in JSON format.

Class com.amazonaws.services.iotdata.model.GetThingShadowRequest

class GetThingShadowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iotdata.model.GetThingShadowResult

class GetThingShadowResult extends Object implements Serializable

Serialized Fields

payload

ByteBuffer payload

The state information, in JSON format.

Exception Class com.amazonaws.services.iotdata.model.InternalFailureException

class InternalFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iotdata.model.InvalidRequestException

class InvalidRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iotdata.model.MethodNotAllowedException

class MethodNotAllowedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.PublishRequest

class PublishRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

payload

ByteBuffer payload

The state information, in JSON format.

qos

Integer qos

The Quality of Service (QoS) level.

topic

String topic

The name of the MQTT topic.

Class com.amazonaws.services.iotdata.model.PublishResult

class PublishResult extends Object implements Serializable

Exception Class com.amazonaws.services.iotdata.model.RequestEntityTooLargeException

class RequestEntityTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iotdata.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iotdata.model.ServiceUnavailableException

class ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iotdata.model.ThrottlingException

class ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iotdata.model.UnauthorizedException

class UnauthorizedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.iotdata.model.UnsupportedDocumentEncodingException

class UnsupportedDocumentEncodingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.iotdata.model.UpdateThingShadowRequest

class UpdateThingShadowRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

payload

ByteBuffer payload

The state information, in JSON format.

thingName

String thingName

The name of the thing.

Class com.amazonaws.services.iotdata.model.UpdateThingShadowResult

class 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

class AddTagsToStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

String streamName

The name of the stream.

tags

com.amazonaws.internal.SdkInternalMap<String,String> tags

The set of key-value pairs to use to create the tags.

Class com.amazonaws.services.kinesis.model.AddTagsToStreamResult

class AddTagsToStreamResult extends Object implements Serializable

Class com.amazonaws.services.kinesis.model.CreateStreamRequest

class CreateStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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;

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.

Class com.amazonaws.services.kinesis.model.CreateStreamResult

class CreateStreamResult extends Object implements Serializable

Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodRequest

class DecreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

retentionPeriodHours

Integer retentionPeriodHours

The new retention period of the stream, in hours. Must be less than the current retention period.

streamName

String streamName

The name of the stream to modify.

Class com.amazonaws.services.kinesis.model.DecreaseStreamRetentionPeriodResult

class DecreaseStreamRetentionPeriodResult extends Object implements Serializable

Class com.amazonaws.services.kinesis.model.DeleteStreamRequest

class DeleteStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

String streamName

The name of the stream to delete.

Class com.amazonaws.services.kinesis.model.DeleteStreamResult

class DeleteStreamResult extends Object implements Serializable

Class com.amazonaws.services.kinesis.model.DescribeStreamRequest

class DescribeStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartShardId

String exclusiveStartShardId

The shard ID of the shard to start with.

limit

Integer limit

The maximum number of shards to return.

streamName

String streamName

The name of the stream to describe.

Class com.amazonaws.services.kinesis.model.DescribeStreamResult

class 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

class DisableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shardLevelMetrics

com.amazonaws.internal.SdkInternalList<String> 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.

streamName

String streamName

The name of the Amazon Kinesis stream for which to disable enhanced monitoring.

Class com.amazonaws.services.kinesis.model.DisableEnhancedMonitoringResult

class DisableEnhancedMonitoringResult extends Object implements Serializable

Serialized Fields

currentShardLevelMetrics

com.amazonaws.internal.SdkInternalList<String> currentShardLevelMetrics

Represents the current state of the metrics that are in the enhanced state before the operation.

desiredShardLevelMetrics

com.amazonaws.internal.SdkInternalList<String> desiredShardLevelMetrics

Represents the list of all the metrics that would be in the enhanced state after the operation.

streamName

String streamName

The name of the Amazon Kinesis stream.

Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringRequest

class EnableEnhancedMonitoringRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

shardLevelMetrics

com.amazonaws.internal.SdkInternalList<String> 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.

streamName

String streamName

The name of the stream for which to enable enhanced monitoring.

Class com.amazonaws.services.kinesis.model.EnableEnhancedMonitoringResult

class EnableEnhancedMonitoringResult extends Object implements Serializable

Serialized Fields

currentShardLevelMetrics

com.amazonaws.internal.SdkInternalList<String> currentShardLevelMetrics

Represents the current state of the metrics that are in the enhanced state before the operation.

desiredShardLevelMetrics

com.amazonaws.internal.SdkInternalList<String> desiredShardLevelMetrics

Represents the list of all the metrics that would be in the enhanced state after the operation.

streamName

String streamName

The name of the Amazon Kinesis stream.

Class com.amazonaws.services.kinesis.model.EnhancedMetrics

class EnhancedMetrics extends Object implements Serializable

Serialized Fields

shardLevelMetrics

com.amazonaws.internal.SdkInternalList<String> 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.

Exception Class com.amazonaws.services.kinesis.model.ExpiredIteratorException

class ExpiredIteratorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.GetRecordsRequest

class GetRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.kinesis.model.GetRecordsResult

class GetRecordsResult extends Object implements Serializable

Serialized Fields

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.

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.

records

com.amazonaws.internal.SdkInternalList<Record> records

The data records retrieved from the shard.

Class com.amazonaws.services.kinesis.model.GetShardIteratorRequest

class GetShardIteratorRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

streamName

String streamName

The name of the Amazon Kinesis stream.

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

class 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

class HashKeyRange extends Object implements Serializable

Serialized Fields

endingHashKey

String endingHashKey

The ending hash key of the hash key range.

startingHashKey

String startingHashKey

The starting hash key of the hash key range.

Class com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodRequest

class IncreaseStreamRetentionPeriodRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

retentionPeriodHours

Integer retentionPeriodHours

The new retention period of the stream, in hours. Must be more than the current retention period.

streamName

String streamName

The name of the stream to modify.

Class com.amazonaws.services.kinesis.model.IncreaseStreamRetentionPeriodResult

class IncreaseStreamRetentionPeriodResult extends Object implements Serializable

Exception Class com.amazonaws.services.kinesis.model.InvalidArgumentException

class InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kinesis.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.ListStreamsRequest

class ListStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartStreamName

String exclusiveStartStreamName

The name of the stream to start the list with.

limit

Integer limit

The maximum number of streams to list.

Class com.amazonaws.services.kinesis.model.ListStreamsResult

class ListStreamsResult extends Object implements Serializable

Serialized Fields

hasMoreStreams

Boolean hasMoreStreams

If set to true, there are more streams available to list.

streamNames

com.amazonaws.internal.SdkInternalList<String> streamNames

The names of the streams that are associated with the AWS account making the ListStreams request.

Class com.amazonaws.services.kinesis.model.ListTagsForStreamRequest

class ListTagsForStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

streamName

String streamName

The name of the stream.

Class com.amazonaws.services.kinesis.model.ListTagsForStreamResult

class ListTagsForStreamResult extends Object implements Serializable

Serialized Fields

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.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

A list of tags associated with StreamName, starting with the first tag after ExclusiveStartTagKey and up to the specified Limit.

Class com.amazonaws.services.kinesis.model.MergeShardsRequest

class MergeShardsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

adjacentShardToMerge

String adjacentShardToMerge

The shard ID of the adjacent shard for the merge.

shardToMerge

String shardToMerge

The shard ID of the shard to combine with the adjacent shard for the merge.

streamName

String streamName

The name of the stream for the merge.

Class com.amazonaws.services.kinesis.model.MergeShardsResult

class MergeShardsResult extends Object implements Serializable

Exception Class com.amazonaws.services.kinesis.model.ProvisionedThroughputExceededException

class ProvisionedThroughputExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.PutRecordRequest

class PutRecordRequest extends AmazonWebServiceRequest 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 explicitly determine the shard 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.

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.

streamName

String streamName

The name of the stream to put the data record into.

Class com.amazonaws.services.kinesis.model.PutRecordResult

class PutRecordResult extends Object implements Serializable

Serialized Fields

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.

shardId

String shardId

The shard ID of the shard where the data record was placed.

Class com.amazonaws.services.kinesis.model.PutRecordsRequest

class PutRecordsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

records

com.amazonaws.internal.SdkInternalList<PutRecordsRequestEntry> records

The records associated with the request.

streamName

String streamName

The stream name associated with the request.

Class com.amazonaws.services.kinesis.model.PutRecordsRequestEntry

class 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

class 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<PutRecordsResultEntry> 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

class PutRecordsResultEntry extends Object implements Serializable

Serialized Fields

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

sequenceNumber

String sequenceNumber

The sequence number for an individual record result.

shardId

String shardId

The shard ID for an individual record result.

Class com.amazonaws.services.kinesis.model.Record

class Record extends Object implements Serializable

Serialized Fields

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.

sequenceNumber

String sequenceNumber

The unique identifier of the record in the stream.

Class com.amazonaws.services.kinesis.model.RemoveTagsFromStreamRequest

class RemoveTagsFromStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

streamName

String streamName

The name of the stream.

tagKeys

com.amazonaws.internal.SdkInternalList<String> tagKeys

A list of tag keys. Each corresponding tag is removed from the stream.

Class com.amazonaws.services.kinesis.model.RemoveTagsFromStreamResult

class RemoveTagsFromStreamResult extends Object implements Serializable

Exception Class com.amazonaws.services.kinesis.model.ResourceInUseException

class ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kinesis.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesis.model.SequenceNumberRange

class SequenceNumberRange extends Object implements Serializable

Serialized Fields

endingSequenceNumber

String endingSequenceNumber

The ending sequence number for the range. Shards that are in the OPEN state have an ending sequence number of null.

startingSequenceNumber

String startingSequenceNumber

The starting sequence number for the range.

Class com.amazonaws.services.kinesis.model.Shard

class Shard extends Object implements Serializable

Serialized Fields

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.

parentShardId

String parentShardId

The shard ID of the shard's parent.

sequenceNumberRange

SequenceNumberRange sequenceNumberRange

The range of possible sequence numbers for the shard.

shardId

String shardId

The unique identifier of the shard within the stream.

Class com.amazonaws.services.kinesis.model.SplitShardRequest

class SplitShardRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

shardToSplit

String shardToSplit

The shard ID of the shard to split.

streamName

String streamName

The name of the stream for the shard split.

Class com.amazonaws.services.kinesis.model.SplitShardResult

class SplitShardResult extends Object implements Serializable

Class com.amazonaws.services.kinesis.model.StreamDescription

class StreamDescription extends Object implements Serializable

Serialized Fields

enhancedMonitoring

com.amazonaws.internal.SdkInternalList<EnhancedMetrics> enhancedMonitoring

Represents the current enhanced monitoring settings of 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.

shards

com.amazonaws.internal.SdkInternalList<Shard> shards

The shards that comprise the stream.

streamARN

String streamARN

The Amazon Resource Name (ARN) for the stream being described.

streamName

String streamName

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

Class com.amazonaws.services.kinesis.model.Tag

class 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

class BufferingHints 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.

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

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

Exception Class com.amazonaws.services.kinesisfirehose.model.ConcurrentModificationException

class ConcurrentModificationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisfirehose.model.CopyCommand

class CopyCommand extends Object implements Serializable

Serialized Fields

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.

dataTableColumns

String dataTableColumns

A comma-separated list of column names.

dataTableName

String dataTableName

The name of the target table. The table must already exist in the database.

Class com.amazonaws.services.kinesisfirehose.model.CreateDeliveryStreamRequest

class CreateDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryStreamName

String deliveryStreamName

The name of the delivery stream.

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

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

s3DestinationConfiguration

S3DestinationConfiguration s3DestinationConfiguration

The destination in Amazon S3. This value must be specified if ElasticsearchDestinationConfiguration or RedshiftDestinationConfiguration is specified (see restrictions listed above).

Class com.amazonaws.services.kinesisfirehose.model.CreateDeliveryStreamResult

class CreateDeliveryStreamResult extends Object implements Serializable

Serialized Fields

deliveryStreamARN

String deliveryStreamARN

The ARN of the delivery stream.

Class com.amazonaws.services.kinesisfirehose.model.DeleteDeliveryStreamRequest

class DeleteDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryStreamName

String deliveryStreamName

The name of the delivery stream.

Class com.amazonaws.services.kinesisfirehose.model.DeleteDeliveryStreamResult

class DeleteDeliveryStreamResult extends Object implements Serializable

Class com.amazonaws.services.kinesisfirehose.model.DeliveryStreamDescription

class DeliveryStreamDescription extends Object implements Serializable

Serialized Fields

createTimestamp

Date createTimestamp

The date and time that the delivery stream was created.

deliveryStreamARN

String deliveryStreamARN

The Amazon Resource Name (ARN) of the delivery stream.

deliveryStreamName

String deliveryStreamName

The name of the delivery stream.

deliveryStreamStatus

String deliveryStreamStatus

The status of the delivery stream.

destinations

List<DestinationDescription> destinations

The destinations.

hasMoreDestinations

Boolean hasMoreDestinations

Indicates whether there are more destinations available to list.

lastUpdateTimestamp

Date lastUpdateTimestamp

The date and time that the delivery stream was last updated.

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.

Class com.amazonaws.services.kinesisfirehose.model.DescribeDeliveryStreamRequest

class DescribeDeliveryStreamRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryStreamName

String deliveryStreamName

The name of the delivery stream.

exclusiveStartDestinationId

String exclusiveStartDestinationId

Specifies the destination ID to start returning the destination information. Currently Firehose supports one destination per delivery stream.

limit

Integer limit

The limit on the number of destinations to return. Currently, you can have one destination per delivery stream.

Class com.amazonaws.services.kinesisfirehose.model.DescribeDeliveryStreamResult

class DescribeDeliveryStreamResult extends Object implements Serializable

Serialized Fields

deliveryStreamDescription

DeliveryStreamDescription deliveryStreamDescription

Information about the delivery stream.

Class com.amazonaws.services.kinesisfirehose.model.DestinationDescription

class DestinationDescription extends Object implements Serializable

Serialized Fields

destinationId

String destinationId

The ID of the destination.

elasticsearchDestinationDescription

ElasticsearchDestinationDescription elasticsearchDestinationDescription

The destination in Amazon ES.

redshiftDestinationDescription

RedshiftDestinationDescription redshiftDestinationDescription

The destination in Amazon Redshift.

s3DestinationDescription

S3DestinationDescription s3DestinationDescription

The Amazon S3 destination.

Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchBufferingHints

class 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

class ElasticsearchDestinationConfiguration extends Object implements Serializable

Serialized Fields

bufferingHints

ElasticsearchBufferingHints bufferingHints

Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

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.

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.

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

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.

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

typeName

String typeName

The Elasticsearch type name.

Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationDescription

class ElasticsearchDestinationDescription extends Object implements Serializable

Serialized Fields

bufferingHints

ElasticsearchBufferingHints bufferingHints

Buffering options.

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

CloudWatch logging options.

domainARN

String domainARN

The ARN of the Amazon ES domain.

indexName

String indexName

The Elasticsearch index name.

indexRotationPeriod

String indexRotationPeriod

The Elasticsearch index rotation period

retryOptions

ElasticsearchRetryOptions retryOptions

Elasticsearch retry options.

roleARN

String roleARN

The ARN of the AWS credentials.

s3BackupMode

String s3BackupMode

Amazon S3 backup mode.

s3DestinationDescription

S3DestinationDescription s3DestinationDescription

typeName

String typeName

The Elasticsearch type name.

Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchDestinationUpdate

class ElasticsearchDestinationUpdate extends Object implements Serializable

Serialized Fields

bufferingHints

ElasticsearchBufferingHints bufferingHints

Buffering options. If no value is specified, ElasticsearchBufferingHints object default values are used.

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

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.

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.

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

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.

s3Update

S3DestinationUpdate s3Update

typeName

String typeName

The Elasticsearch type name.

Class com.amazonaws.services.kinesisfirehose.model.ElasticsearchRetryOptions

class 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 (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.

Class com.amazonaws.services.kinesisfirehose.model.EncryptionConfiguration

class EncryptionConfiguration extends Object implements Serializable

Serialized Fields

kMSEncryptionConfig

KMSEncryptionConfig kMSEncryptionConfig

The encryption key.

noEncryptionConfig

String noEncryptionConfig

Specifically override existing encryption information to ensure no encryption is used.

Exception Class com.amazonaws.services.kinesisfirehose.model.InvalidArgumentException

class InvalidArgumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisfirehose.model.KMSEncryptionConfig

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

Exception Class com.amazonaws.services.kinesisfirehose.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisfirehose.model.ListDeliveryStreamsRequest

class ListDeliveryStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

exclusiveStartDeliveryStreamName

String exclusiveStartDeliveryStreamName

The name of the delivery stream to start the list with.

limit

Integer limit

The maximum number of delivery streams to list.

Class com.amazonaws.services.kinesisfirehose.model.ListDeliveryStreamsResult

class ListDeliveryStreamsResult extends Object implements Serializable

Serialized Fields

deliveryStreamNames

List<String> 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

class PutRecordBatchRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deliveryStreamName

String deliveryStreamName

The name of the delivery stream.

records

List<Record> records

One or more records.

Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResponseEntry

class PutRecordBatchResponseEntry extends Object implements Serializable

Serialized Fields

errorCode

String errorCode

The error code for an individual record result.

errorMessage

String errorMessage

The error message for an individual record result.

recordId

String recordId

The ID of the record.

Class com.amazonaws.services.kinesisfirehose.model.PutRecordBatchResult

class PutRecordBatchResult extends Object implements Serializable

Serialized Fields

failedPutCount

Integer failedPutCount

The number of unsuccessfully written records.

requestResponses

List<PutRecordBatchResponseEntry> 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

class 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

class PutRecordResult extends Object implements Serializable

Serialized Fields

recordId

String recordId

The ID of the record.

Class com.amazonaws.services.kinesisfirehose.model.Record

class 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

class RedshiftDestinationConfiguration extends Object implements Serializable

Serialized Fields

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

clusterJDBCURL

String clusterJDBCURL

The database connection string.

copyCommand

CopyCommand copyCommand

The COPY command.

password

String password

The user password.

retryOptions

RedshiftRetryOptions retryOptions

Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

roleARN

String roleARN

The ARN of the AWS credentials.

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.

username

String username

The name of the user.

Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationDescription

class RedshiftDestinationDescription extends Object implements Serializable

Serialized Fields

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

clusterJDBCURL

String clusterJDBCURL

The database connection string.

copyCommand

CopyCommand copyCommand

The COPY command.

retryOptions

RedshiftRetryOptions retryOptions

Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

roleARN

String roleARN

The ARN of the AWS credentials.

s3DestinationDescription

S3DestinationDescription s3DestinationDescription

The Amazon S3 destination.

username

String username

The name of the user.

Class com.amazonaws.services.kinesisfirehose.model.RedshiftDestinationUpdate

class RedshiftDestinationUpdate extends Object implements Serializable

Serialized Fields

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

clusterJDBCURL

String clusterJDBCURL

The database connection string.

copyCommand

CopyCommand copyCommand

The COPY command.

password

String password

The user password.

retryOptions

RedshiftRetryOptions retryOptions

Configures retry behavior in the event that Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).

roleARN

String roleARN

The ARN of the AWS credentials.

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.

username

String username

The name of the user.

Class com.amazonaws.services.kinesisfirehose.model.RedshiftRetryOptions

class RedshiftRetryOptions extends Object implements Serializable

Serialized Fields

durationInSeconds

Integer durationInSeconds

The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of DurationInSeconds is 0 (zero) or if the first delivery attempt takes longer than the current value.

Exception Class com.amazonaws.services.kinesisfirehose.model.ResourceInUseException

class ResourceInUseException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kinesisfirehose.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisfirehose.model.S3DestinationConfiguration

class S3DestinationConfiguration extends Object implements Serializable

Serialized Fields

bucketARN

String bucketARN

The ARN of the S3 bucket.

bufferingHints

BufferingHints bufferingHints

The buffering option. If no value is specified, BufferingHints object default values are used.

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

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.

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 Amazon Kinesis Firehose Developer Guide.

roleARN

String roleARN

The ARN of the AWS credentials.

Class com.amazonaws.services.kinesisfirehose.model.S3DestinationDescription

class S3DestinationDescription extends Object implements Serializable

Serialized Fields

bucketARN

String bucketARN

The ARN of the S3 bucket.

bufferingHints

BufferingHints bufferingHints

The buffering option. If no value is specified, BufferingHints object default values are used.

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

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.

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 Amazon Kinesis Firehose Developer Guide.

roleARN

String roleARN

The ARN of the AWS credentials.

Class com.amazonaws.services.kinesisfirehose.model.S3DestinationUpdate

class S3DestinationUpdate extends Object implements Serializable

Serialized Fields

bucketARN

String bucketARN

The ARN of the S3 bucket.

bufferingHints

BufferingHints bufferingHints

The buffering option. If no value is specified, BufferingHints object default values are used.

cloudWatchLoggingOptions

CloudWatchLoggingOptions cloudWatchLoggingOptions

Describes CloudWatch logging options for your delivery stream.

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.

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 Amazon Kinesis Firehose Developer Guide.

roleARN

String roleARN

The ARN of the AWS credentials.

Exception Class com.amazonaws.services.kinesisfirehose.model.ServiceUnavailableException

class ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kinesisfirehose.model.UpdateDestinationRequest

class UpdateDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

deliveryStreamName

String deliveryStreamName

The name of the delivery stream.

destinationId

String destinationId

The ID of the destination.

elasticsearchDestinationUpdate

ElasticsearchDestinationUpdate elasticsearchDestinationUpdate

Describes an update for a destination in Amazon ES.

redshiftDestinationUpdate

RedshiftDestinationUpdate redshiftDestinationUpdate

Describes an update for a destination in Amazon Redshift.

s3DestinationUpdate

S3DestinationUpdate s3DestinationUpdate

Describes an update for a destination in Amazon S3.

Class com.amazonaws.services.kinesisfirehose.model.UpdateDestinationResult

class UpdateDestinationResult extends Object implements Serializable

Package com.amazonaws.services.kms.model

Class com.amazonaws.services.kms.model.AliasListEntry

class AliasListEntry extends Object implements Serializable

Serialized Fields

aliasArn

String aliasArn

String that contains the key ARN.

aliasName

String aliasName

String that contains the alias.

targetKeyId

String targetKeyId

String that contains the key identifier pointed to by the alias.

Exception Class com.amazonaws.services.kms.model.AlreadyExistsException

class AlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.CancelKeyDeletionRequest

class 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

class 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

class 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.CreateAliasResult

class CreateAliasResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.CreateGrantRequest

class CreateGrantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

grantTokens

com.amazonaws.internal.SdkInternalList<String> grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

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.

operations

com.amazonaws.internal.SdkInternalList<String> 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

• DescribeKey

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.

Class com.amazonaws.services.kms.model.CreateGrantResult

class CreateGrantResult extends Object implements Serializable

Serialized Fields

grantId

String grantId

The unique identifier for the grant.

You can use the GrantId in a subsequent RetireGrant or RevokeGrant operation.

grantToken

String grantToken

The grant token.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Class com.amazonaws.services.kms.model.CreateKeyRequest

class CreateKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bypassPolicyLockoutSafetyCheck

Boolean bypassPolicyLockoutSafetyCheck

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

Use this parameter only when you include a policy in the request and you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.

The default value is false.

description

String description

A description of the CMK.

Use a description that helps you decide whether the CMK is appropriate for a task.

keyUsage

String keyUsage

The intended use of the CMK.

You can use CMKs only for symmetric encryption and decryption.

policy

String policy

The key policy to attach to the CMK.

If you specify a key policy, it must meet the following criteria:

• It must allow the principal making the CreateKey request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

• The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.

If you do not specify a policy, AWS KMS attaches a default key policy to the CMK. For more information, see Default Key Policy in the AWS Key Management Service Developer Guide.

The policy size limit is 32 KiB (32768 bytes).

Class com.amazonaws.services.kms.model.CreateKeyResult

class CreateKeyResult extends Object implements Serializable

Serialized Fields

keyMetadata

KeyMetadata keyMetadata

Metadata associated with the CMK.

Class com.amazonaws.services.kms.model.DecryptRequest

class DecryptRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ciphertextBlob

ByteBuffer ciphertextBlob

Ciphertext to be decrypted. The blob includes metadata.

encryptionContext

com.amazonaws.internal.SdkInternalMap<String,String> 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<String> grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

Class com.amazonaws.services.kms.model.DecryptResult

class 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

class 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.DeleteAliasResult

class DeleteAliasResult extends Object implements Serializable

Exception Class com.amazonaws.services.kms.model.DependencyTimeoutException

class DependencyTimeoutException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.DescribeKeyRequest

class DescribeKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantTokens

com.amazonaws.internal.SdkInternalList<String> grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

Class com.amazonaws.services.kms.model.DescribeKeyResult

class DescribeKeyResult extends Object implements Serializable

Serialized Fields

keyMetadata

KeyMetadata keyMetadata

Metadata associated with the key.

Exception Class com.amazonaws.services.kms.model.DisabledException

class DisabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.DisableKeyRequest

class DisableKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

keyId

String keyId

A unique identifier for the CMK.

Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

• Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab

Class com.amazonaws.services.kms.model.DisableKeyResult

class DisableKeyResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.DisableKeyRotationRequest

class 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.DisableKeyRotationResult

class DisableKeyRotationResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.EnableKeyRequest

class 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.EnableKeyResult

class EnableKeyResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.EnableKeyRotationRequest

class 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.EnableKeyRotationResult

class EnableKeyRotationResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.EncryptRequest

class EncryptRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionContext

com.amazonaws.internal.SdkInternalMap<String,String> 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<String> grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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.

Class com.amazonaws.services.kms.model.EncryptResult

class 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

class GenerateDataKeyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionContext

com.amazonaws.internal.SdkInternalMap<String,String> 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.

grantTokens

com.amazonaws.internal.SdkInternalList<String> grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

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.

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.

Class com.amazonaws.services.kms.model.GenerateDataKeyResult

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

keyId

String keyId

System generated unique identifier of the key to be used to decrypt the encrypted copy of the data key.

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.

Class com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextRequest

class GenerateDataKeyWithoutPlaintextRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

encryptionContext

com.amazonaws.internal.SdkInternalMap<String,String> encryptionContext

Name:value pair that contains additional data to be authenticated during the encryption and decryption processes.

grantTokens

com.amazonaws.internal.SdkInternalList<String> grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

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

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.

Class com.amazonaws.services.kms.model.GenerateDataKeyWithoutPlaintextResult

class 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

class 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

class GenerateRandomResult extends Object implements Serializable

Serialized Fields

plaintext

ByteBuffer plaintext

Plaintext that contains the unpredictable byte string.

Class com.amazonaws.services.kms.model.GetKeyPolicyRequest

class 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

class GetKeyPolicyResult extends Object implements Serializable

Serialized Fields

policy

String policy

A policy document in JSON format.

Class com.amazonaws.services.kms.model.GetKeyRotationStatusRequest

class 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

class 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

class GrantConstraints extends Object implements Serializable

Serialized Fields

encryptionContextEquals

com.amazonaws.internal.SdkInternalMap<String,String> 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.

encryptionContextSubset

com.amazonaws.internal.SdkInternalMap<String,String> 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.

Class com.amazonaws.services.kms.model.GrantListEntry

class GrantListEntry extends Object implements Serializable

Serialized Fields

constraints

GrantConstraints constraints

The conditions under which the grant's operations are allowed.

creationDate

Date creationDate

The date and time when the grant was created.

granteePrincipal

String granteePrincipal

The principal that receives the grant's permissions.

grantId

String grantId

The unique identifier for the grant.

issuingAccount

String issuingAccount

The AWS account under which the grant was issued.

keyId

String keyId

The unique identifier for the customer master key (CMK) to which the grant applies.

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.

operations

com.amazonaws.internal.SdkInternalList<String> operations

The list of operations permitted by the grant.

retiringPrincipal

String retiringPrincipal

The principal that can retire the grant.

Exception Class com.amazonaws.services.kms.model.InvalidAliasNameException

class InvalidAliasNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.InvalidArnException

class InvalidArnException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.InvalidCiphertextException

class InvalidCiphertextException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.InvalidGrantIdException

class InvalidGrantIdException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.InvalidGrantTokenException

class InvalidGrantTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.InvalidKeyUsageException

class InvalidKeyUsageException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.InvalidMarkerException

class InvalidMarkerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.KeyListEntry

class KeyListEntry extends Object implements Serializable

Serialized Fields

keyArn

String keyArn

ARN of the key.

keyId

String keyId

Unique identifier of the key.

Class com.amazonaws.services.kms.model.KeyMetadata

class KeyMetadata extends Object implements Serializable

Serialized Fields

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.

aWSAccountId

String aWSAccountId

The twelve-digit account ID of the AWS account that owns the key.

creationDate

Date creationDate

The date and time when the key was created.

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.

description

String description

The friendly description of the key.

enabled

Boolean enabled

Specifies whether the key is enabled. When KeyState is Enabled this value is true, otherwise it is false.

keyId

String keyId

The globally unique identifier for the key.

keyState

String keyState

The state of the customer master key (CMK).

For more information about how key state affects the use of a CMK, see How Key State Affects the Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

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.

Exception Class com.amazonaws.services.kms.model.KeyUnavailableException

class KeyUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.KMSInternalException

class KMSInternalException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.KMSInvalidStateException

class KMSInvalidStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.ListAliasesRequest

class 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

class ListAliasesResult extends Object implements Serializable

Serialized Fields

aliases

com.amazonaws.internal.SdkInternalList<AliasListEntry> 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

class ListGrantsRequest 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

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

class ListGrantsResult extends Object implements Serializable

Serialized Fields

grants

com.amazonaws.internal.SdkInternalList<GrantListEntry> 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

class 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

class ListKeyPoliciesResult extends Object implements Serializable

Serialized Fields

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.

policyNames

com.amazonaws.internal.SdkInternalList<String> policyNames

A list of policy names. Currently, there is only one policy and it is named "Default".

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

class 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

class ListKeysResult extends Object implements Serializable

Serialized Fields

keys

com.amazonaws.internal.SdkInternalList<KeyListEntry> 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

class 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, see 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

class ListRetirableGrantsResult extends Object implements Serializable

Serialized Fields

grants

com.amazonaws.internal.SdkInternalList<GrantListEntry> 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.

Exception Class com.amazonaws.services.kms.model.MalformedPolicyDocumentException

class MalformedPolicyDocumentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.kms.model.NotFoundException

class NotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.PutKeyPolicyRequest

class PutKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

bypassPolicyLockoutSafetyCheck

Boolean bypassPolicyLockoutSafetyCheck

A flag to indicate whether to bypass the key policy lockout safety check.

Setting this value to true increases the likelihood that the CMK becomes unmanageable. Do not set this value to true indiscriminately.

For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

Use this parameter only when you intend to prevent the principal making the request from making a subsequent PutKeyPolicy request on the CMK.

The default value is false.

keyId

String keyId

A unique identifier for the CMK.

Use the CMK's unique identifier or its Amazon Resource Name (ARN). For example:

• Unique ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd- 56ef-1234567890ab

policy

String policy

The key policy to attach to the CMK.

The key policy must meet the following criteria:

• It must allow the principal making the PutKeyPolicy request to make a subsequent PutKeyPolicy request on the CMK. This reduces the likelihood that the CMK becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section in the AWS Key Management Service Developer Guide.

• The principal(s) specified in the key policy must exist and be visible to AWS KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before specifying the new principal in a key policy because the new principal might not immediately be visible to AWS KMS. For more information, see Changes that I make are not always immediately visible in the IAM User Guide.

The policy size limit is 32 KiB (32768 bytes).

policyName

String policyName

The name of the key policy.

This value must be default.

Class com.amazonaws.services.kms.model.PutKeyPolicyResult

class PutKeyPolicyResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.ReEncryptRequest

class ReEncryptRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ciphertextBlob

ByteBuffer ciphertextBlob

Ciphertext of the data to re-encrypt.

destinationEncryptionContext

com.amazonaws.internal.SdkInternalMap<String,String> destinationEncryptionContext

Encryption context to be used when the data is re-encrypted.

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

grantTokens

com.amazonaws.internal.SdkInternalList<String> grantTokens

A list of grant tokens.

For more information, see Grant Tokens in the AWS Key Management Service Developer Guide.

sourceEncryptionContext

com.amazonaws.internal.SdkInternalMap<String,String> sourceEncryptionContext

Encryption context used to encrypt and decrypt the data specified in the CiphertextBlob parameter.

Class com.amazonaws.services.kms.model.ReEncryptResult

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

keyId

String keyId

Unique identifier of the key used to re-encrypt the data.

sourceKeyId

String sourceKeyId

Unique identifier of the key used to originally encrypt the data.

Class com.amazonaws.services.kms.model.RetireGrantRequest

class RetireGrantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantId

String grantId

Unique identifier of the grant to be retired. The grant ID is returned by the CreateGrant function.

• Grant ID Example - 0123456789012345678901234567890123456789012345678901234567890123

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

Class com.amazonaws.services.kms.model.RetireGrantResult

class RetireGrantResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.RevokeGrantRequest

class RevokeGrantRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

grantId

String grantId

Identifier of the grant to be revoked.

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

Class com.amazonaws.services.kms.model.RevokeGrantResult

class RevokeGrantResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.ScheduleKeyDeletionRequest

class 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

class ScheduleKeyDeletionResult extends Object implements Serializable

Serialized Fields

deletionDate

Date deletionDate

The date and time after which AWS KMS deletes the customer master key (CMK).

keyId

String keyId

The unique identifier of the customer master key (CMK) for which deletion is scheduled.

Exception Class com.amazonaws.services.kms.model.UnsupportedOperationException

class UnsupportedOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.kms.model.UpdateAliasRequest

class 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.UpdateAliasResult

class UpdateAliasResult extends Object implements Serializable

Class com.amazonaws.services.kms.model.UpdateKeyDescriptionRequest

class UpdateKeyDescriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

New description for the key.

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

class UpdateKeyDescriptionResult extends Object implements Serializable

Package com.amazonaws.services.lambda.invoke

Exception Class com.amazonaws.services.lambda.invoke.LambdaFunctionException

class LambdaFunctionException extends RuntimeException implements Serializable

serialVersionUID:

1L

Serialized Fields

handled

boolean handled

type

String type

Exception Class com.amazonaws.services.lambda.invoke.LambdaSerializationException

class LambdaSerializationException extends RuntimeException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.lambda.model

Class com.amazonaws.services.lambda.model.AddPermissionRequest

class AddPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

eventSourceToken

String eventSourceToken

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.

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.

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

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.

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.

statementId

String statementId

A unique statement identifier.

Class com.amazonaws.services.lambda.model.AddPermissionResult

class 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

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

description

String description

Alias description.

functionVersion

String functionVersion

Function version to which the alias points.

name

String name

Alias name.

Exception Class com.amazonaws.services.lambda.model.CodeStorageExceededException

class CodeStorageExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Class com.amazonaws.services.lambda.model.CreateAliasRequest

class CreateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

Description of the alias.

functionName

String functionName

Name of the Lambda function for which you want to create an alias.

functionVersion

String functionVersion

Lambda function version for which you are creating the alias.

name

String name

Name for the alias you are creating.

Class com.amazonaws.services.lambda.model.CreateAliasResult

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

description

String description

Alias description.

functionVersion

String functionVersion

Function version to which the alias points.

name

String name

Alias name.

Class com.amazonaws.services.lambda.model.CreateEventSourceMappingRequest

class CreateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

enabled

Boolean enabled

Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.

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.

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.

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.

Class com.amazonaws.services.lambda.model.CreateEventSourceMappingResult

class CreateEventSourceMappingResult extends Object implements Serializable

Serialized Fields

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.

eventSourceArn

String eventSourceArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

functionArn

String functionArn

The Lambda function to invoke when AWS Lambda detects an event on the stream.

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.

uUID

String uUID

The AWS Lambda assigned opaque identifier for the mapping.

Class com.amazonaws.services.lambda.model.CreateFunctionRequest

class CreateFunctionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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

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.

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.

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.

runtime

String runtime

The runtime environment for the Lambda function you are uploading.

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.

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

class CreateFunctionResult extends Object implements Serializable

Serialized Fields

codeSha256

String codeSha256

It is the SHA256 hash of your function deployment package.

codeSize

Long codeSize

The size, in bytes, of the function .zip file you uploaded.

description

String description

The user-provided description.

functionArn

String functionArn

The Amazon Resource Name (ARN) assigned to the function.

functionName

String functionName

The name of the function.

handler

String handler

The function Lambda calls to begin executing your function.

lastModified

String lastModified

The time stamp of the last time you updated the function.

memorySize

Integer memorySize

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

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.

runtime

String runtime

The runtime environment for the Lambda function.

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.

version

String version

The version of the Lambda function.

vpcConfig

VpcConfigResponse vpcConfig

VPC configuration associated with your Lambda function.

Class com.amazonaws.services.lambda.model.DeleteAliasRequest

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

name

String name

Name of the alias to delete.

Class com.amazonaws.services.lambda.model.DeleteAliasResult

class DeleteAliasResult extends Object implements Serializable

Class com.amazonaws.services.lambda.model.DeleteEventSourceMappingRequest

class DeleteEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

uUID

String uUID

The event source mapping ID.

Class com.amazonaws.services.lambda.model.DeleteEventSourceMappingResult

class DeleteEventSourceMappingResult extends Object implements Serializable

Serialized Fields

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.

eventSourceArn

String eventSourceArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

functionArn

String functionArn

The Lambda function to invoke when AWS Lambda detects an event on the stream.

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.

uUID

String uUID

The AWS Lambda assigned opaque identifier for the mapping.

Class com.amazonaws.services.lambda.model.DeleteFunctionRequest

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

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.

Class com.amazonaws.services.lambda.model.DeleteFunctionResult

class DeleteFunctionResult extends Object implements Serializable

Exception Class com.amazonaws.services.lambda.model.EC2AccessDeniedException

class EC2AccessDeniedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.EC2ThrottledException

class EC2ThrottledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.EC2UnexpectedException

class EC2UnexpectedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

eC2ErrorCode

String eC2ErrorCode

type

String type

Exception Class com.amazonaws.services.lambda.model.ENILimitReachedException

class ENILimitReachedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Class com.amazonaws.services.lambda.model.EventSourceMappingConfiguration

class EventSourceMappingConfiguration extends Object implements Serializable

Serialized Fields

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.

eventSourceArn

String eventSourceArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

functionArn

String functionArn

The Lambda function to invoke when AWS Lambda detects an event on the stream.

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.

uUID

String uUID

The AWS Lambda assigned opaque identifier for the mapping.

Class com.amazonaws.services.lambda.model.FunctionCode

class FunctionCode extends Object implements Serializable

Serialized Fields

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.

s3Key

String s3Key

The Amazon S3 object (the deployment package) key name you want to upload.

s3ObjectVersion

String s3ObjectVersion

The Amazon S3 object (the deployment package) version you want to upload.

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.

Class com.amazonaws.services.lambda.model.FunctionCodeLocation

class FunctionCodeLocation extends Object implements Serializable

Serialized Fields

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.

repositoryType

String repositoryType

The repository from which you can download the function.

Class com.amazonaws.services.lambda.model.FunctionConfiguration

class FunctionConfiguration extends Object implements Serializable

Serialized Fields

codeSha256

String codeSha256

It is the SHA256 hash of your function deployment package.

codeSize

Long codeSize

The size, in bytes, of the function .zip file you uploaded.

description

String description

The user-provided description.

functionArn

String functionArn

The Amazon Resource Name (ARN) assigned to the function.

functionName

String functionName

The name of the function.

handler

String handler

The function Lambda calls to begin executing your function.

lastModified

String lastModified

The time stamp of the last time you updated the function.

memorySize

Integer memorySize

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

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.

runtime

String runtime

The runtime environment for the Lambda function.

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.

version

String version

The version of the Lambda function.

vpcConfig

VpcConfigResponse vpcConfig

VPC configuration associated with your Lambda function.

Class com.amazonaws.services.lambda.model.GetAliasRequest

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

name

String name

Name of the alias for which you want to retrieve information.

Class com.amazonaws.services.lambda.model.GetAliasResult

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

description

String description

Alias description.

functionVersion

String functionVersion

Function version to which the alias points.

name

String name

Alias name.

Class com.amazonaws.services.lambda.model.GetEventSourceMappingRequest

class 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

class GetEventSourceMappingResult extends Object implements Serializable

Serialized Fields

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.

eventSourceArn

String eventSourceArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

functionArn

String functionArn

The Lambda function to invoke when AWS Lambda detects an event on the stream.

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.

uUID

String uUID

The AWS Lambda assigned opaque identifier for the mapping.

Class com.amazonaws.services.lambda.model.GetFunctionConfigurationRequest

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

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.

Class com.amazonaws.services.lambda.model.GetFunctionConfigurationResult

class GetFunctionConfigurationResult extends Object implements Serializable

Serialized Fields

codeSha256

String codeSha256

It is the SHA256 hash of your function deployment package.

codeSize

Long codeSize

The size, in bytes, of the function .zip file you uploaded.

description

String description

The user-provided description.

functionArn

String functionArn

The Amazon Resource Name (ARN) assigned to the function.

functionName

String functionName

The name of the function.

handler

String handler

The function Lambda calls to begin executing your function.

lastModified

String lastModified

The time stamp of the last time you updated the function.

memorySize

Integer memorySize

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

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.

runtime

String runtime

The runtime environment for the Lambda function.

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.

version

String version

The version of the Lambda function.

vpcConfig

VpcConfigResponse vpcConfig

VPC configuration associated with your Lambda function.

Class com.amazonaws.services.lambda.model.GetFunctionRequest

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

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.

Class com.amazonaws.services.lambda.model.GetFunctionResult

class GetFunctionResult extends Object implements Serializable

Serialized Fields

code

FunctionCodeLocation code

configuration

FunctionConfiguration configuration

Class com.amazonaws.services.lambda.model.GetPolicyRequest

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

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.

Class com.amazonaws.services.lambda.model.GetPolicyResult

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

Exception Class com.amazonaws.services.lambda.model.InvalidParameterValueException

class InvalidParameterValueException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.InvalidRequestContentException

class InvalidRequestContentException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.InvalidSecurityGroupIDException

class InvalidSecurityGroupIDException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.InvalidSubnetIDException

class InvalidSubnetIDException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Class com.amazonaws.services.lambda.model.InvokeAsyncRequest

class InvokeAsyncRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

functionName

String functionName

The Lambda function name.

invokeArgs

InputStream invokeArgs

JSON that you want to provide to your Lambda function as input.

Class com.amazonaws.services.lambda.model.InvokeAsyncResult

class InvokeAsyncResult extends Object implements Serializable

Serialized Fields

status

Integer status

Deprecated.

It will be 202 upon success.

Class com.amazonaws.services.lambda.model.InvokeRequest

class InvokeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

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.

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.

Class com.amazonaws.services.lambda.model.InvokeResult

class InvokeResult extends Object implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.lambda.model.ListAliasesRequest

class ListAliasesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

functionName

String functionName

Lambda function name for which the alias is created.

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.

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.

Class com.amazonaws.services.lambda.model.ListAliasesResult

class ListAliasesResult extends Object implements Serializable

Serialized Fields

aliases

com.amazonaws.internal.SdkInternalList<AliasConfiguration> aliases

A list of aliases.

nextMarker

String nextMarker

A string, present if there are more aliases.

Class com.amazonaws.services.lambda.model.ListEventSourceMappingsRequest

class ListEventSourceMappingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eventSourceArn

String eventSourceArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream.

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.

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.

Class com.amazonaws.services.lambda.model.ListEventSourceMappingsResult

class ListEventSourceMappingsResult extends Object implements Serializable

Serialized Fields

eventSourceMappings

com.amazonaws.internal.SdkInternalList<EventSourceMappingConfiguration> eventSourceMappings

An array of EventSourceMappingConfiguration objects.

nextMarker

String nextMarker

A string, present if there are more event source mappings.

Class com.amazonaws.services.lambda.model.ListFunctionsRequest

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

Class com.amazonaws.services.lambda.model.ListFunctionsResult

class ListFunctionsResult extends Object implements Serializable

Serialized Fields

functions

com.amazonaws.internal.SdkInternalList<FunctionConfiguration> functions

A list of Lambda functions.

nextMarker

String nextMarker

A string, present if there are more functions.

Class com.amazonaws.services.lambda.model.ListVersionsByFunctionRequest

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

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.

Class com.amazonaws.services.lambda.model.ListVersionsByFunctionResult

class ListVersionsByFunctionResult extends Object implements Serializable

Serialized Fields

nextMarker

String nextMarker

A string, present if there are more function versions.

versions

com.amazonaws.internal.SdkInternalList<FunctionConfiguration> versions

A list of Lambda function versions.

Exception Class com.amazonaws.services.lambda.model.PolicyLengthExceededException

class PolicyLengthExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Class com.amazonaws.services.lambda.model.PublishVersionRequest

class PublishVersionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.lambda.model.PublishVersionResult

class PublishVersionResult extends Object implements Serializable

Serialized Fields

codeSha256

String codeSha256

It is the SHA256 hash of your function deployment package.

codeSize

Long codeSize

The size, in bytes, of the function .zip file you uploaded.

description

String description

The user-provided description.

functionArn

String functionArn

The Amazon Resource Name (ARN) assigned to the function.

functionName

String functionName

The name of the function.

handler

String handler

The function Lambda calls to begin executing your function.

lastModified

String lastModified

The time stamp of the last time you updated the function.

memorySize

Integer memorySize

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

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.

runtime

String runtime

The runtime environment for the Lambda function.

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.

version

String version

The version of the Lambda function.

vpcConfig

VpcConfigResponse vpcConfig

VPC configuration associated with your Lambda function.

Class com.amazonaws.services.lambda.model.RemovePermissionRequest

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

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.

statementId

String statementId

Statement ID of the permission to remove.

Class com.amazonaws.services.lambda.model.RemovePermissionResult

class RemovePermissionResult extends Object implements Serializable

Exception Class com.amazonaws.services.lambda.model.RequestTooLargeException

class RequestTooLargeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.ResourceConflictException

class ResourceConflictException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.ServiceException

class ServiceException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.SubnetIPAddressLimitReachedException

class SubnetIPAddressLimitReachedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Exception Class com.amazonaws.services.lambda.model.TooManyRequestsException

class TooManyRequestsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

retryAfterSeconds

String retryAfterSeconds

The number of seconds the caller should wait before retrying.

type

String type

Exception Class com.amazonaws.services.lambda.model.UnsupportedMediaTypeException

class UnsupportedMediaTypeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

type

String type

Class com.amazonaws.services.lambda.model.UpdateAliasRequest

class UpdateAliasRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

You can change the description of the alias using this parameter.

functionName

String functionName

The function name for which the alias is created.

functionVersion

String functionVersion

Using this parameter you can change the Lambda function version to which the alias points.

name

String name

The alias name.

Class com.amazonaws.services.lambda.model.UpdateAliasResult

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

description

String description

Alias description.

functionVersion

String functionVersion

Function version to which the alias points.

name

String name

Alias name.

Class com.amazonaws.services.lambda.model.UpdateEventSourceMappingRequest

class UpdateEventSourceMappingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

batchSize

Integer batchSize

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

enabled

Boolean enabled

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

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.

uUID

String uUID

The event source mapping identifier.

Class com.amazonaws.services.lambda.model.UpdateEventSourceMappingResult

class UpdateEventSourceMappingResult extends Object implements Serializable

Serialized Fields

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.

eventSourceArn

String eventSourceArn

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

functionArn

String functionArn

The Lambda function to invoke when AWS Lambda detects an event on the stream.

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.

uUID

String uUID

The AWS Lambda assigned opaque identifier for the mapping.

Class com.amazonaws.services.lambda.model.UpdateFunctionCodeRequest

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

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.

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.

s3Key

String s3Key

The Amazon S3 object (the deployment package) key name you want to upload.

s3ObjectVersion

String s3ObjectVersion

The Amazon S3 object (the deployment package) version you want to upload.

zipFile

ByteBuffer zipFile

Based64-encoded .zip file containing your packaged source code.

Class com.amazonaws.services.lambda.model.UpdateFunctionCodeResult

class UpdateFunctionCodeResult extends Object implements Serializable

Serialized Fields

codeSha256

String codeSha256

It is the SHA256 hash of your function deployment package.

codeSize

Long codeSize

The size, in bytes, of the function .zip file you uploaded.

description

String description

The user-provided description.

functionArn

String functionArn

The Amazon Resource Name (ARN) assigned to the function.

functionName

String functionName

The name of the function.

handler

String handler

The function Lambda calls to begin executing your function.

lastModified

String lastModified

The time stamp of the last time you updated the function.

memorySize

Integer memorySize

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

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.

runtime

String runtime

The runtime environment for the Lambda function.

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.

version

String version

The version of the Lambda function.

vpcConfig

VpcConfigResponse vpcConfig

VPC configuration associated with your Lambda function.

Class com.amazonaws.services.lambda.model.UpdateFunctionConfigurationRequest

class UpdateFunctionConfigurationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

description

String description

A short user-defined function description. AWS Lambda does not use this value. Assign a meaningful description as you see fit.

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.

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.

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.

role

String role

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

runtime

String runtime

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.

vpcConfig

VpcConfig vpcConfig

Class com.amazonaws.services.lambda.model.UpdateFunctionConfigurationResult

class UpdateFunctionConfigurationResult extends Object implements Serializable

Serialized Fields

codeSha256

String codeSha256

It is the SHA256 hash of your function deployment package.

codeSize

Long codeSize

The size, in bytes, of the function .zip file you uploaded.

description

String description

The user-provided description.

functionArn

String functionArn

The Amazon Resource Name (ARN) assigned to the function.

functionName

String functionName

The name of the function.

handler

String handler

The function Lambda calls to begin executing your function.

lastModified

String lastModified

The time stamp of the last time you updated the function.

memorySize

Integer memorySize

The memory size, in MB, you configured for the function. Must be a multiple of 64 MB.

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.

runtime

String runtime

The runtime environment for the Lambda function.

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.

version

String version

The version of the Lambda function.

vpcConfig

VpcConfigResponse vpcConfig

VPC configuration associated with your Lambda function.

Class com.amazonaws.services.lambda.model.VpcConfig

class VpcConfig extends Object implements Serializable

Serialized Fields

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> securityGroupIds

A list of one or more security groups IDs in your VPC.

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

A list of one or more subnet IDs in your VPC.

Class com.amazonaws.services.lambda.model.VpcConfigResponse

class VpcConfigResponse extends Object implements Serializable

Serialized Fields

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> securityGroupIds

A list of security group IDs associated with the Lambda function.

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

A list of subnet IDs associated with the Lambda function.

vpcId

String vpcId

The VPC ID associated with you Lambda function.

Package com.amazonaws.services.logs.model

Class com.amazonaws.services.logs.model.CancelExportTaskRequest

class CancelExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

taskId

String taskId

Id of the export task to cancel.

Class com.amazonaws.services.logs.model.CancelExportTaskResult

class CancelExportTaskResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.CreateExportTaskRequest

class CreateExportTaskRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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.

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.

taskName

String taskName

The name of the export task.

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.

Class com.amazonaws.services.logs.model.CreateExportTaskResult

class 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

class CreateLogGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

String logGroupName

The name of the log group to create.

Class com.amazonaws.services.logs.model.CreateLogGroupResult

class CreateLogGroupResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.CreateLogStreamRequest

class 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.CreateLogStreamResult

class CreateLogStreamResult extends Object implements Serializable

Exception Class com.amazonaws.services.logs.model.DataAlreadyAcceptedException

class DataAlreadyAcceptedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

expectedSequenceToken

String expectedSequenceToken

Class com.amazonaws.services.logs.model.DeleteDestinationRequest

class DeleteDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationName

String destinationName

The name of destination to delete.

Class com.amazonaws.services.logs.model.DeleteDestinationResult

class DeleteDestinationResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.DeleteLogGroupRequest

class DeleteLogGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logGroupName

String logGroupName

The name of the log group to delete.

Class com.amazonaws.services.logs.model.DeleteLogGroupResult

class DeleteLogGroupResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.DeleteLogStreamRequest

class 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.DeleteLogStreamResult

class DeleteLogStreamResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.DeleteMetricFilterRequest

class DeleteMetricFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterName

String filterName

The name of the metric filter to delete.

logGroupName

String logGroupName

The name of the log group that is associated with the metric filter to delete.

Class com.amazonaws.services.logs.model.DeleteMetricFilterResult

class DeleteMetricFilterResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.DeleteRetentionPolicyRequest

class 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.DeleteRetentionPolicyResult

class DeleteRetentionPolicyResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.DeleteSubscriptionFilterRequest

class DeleteSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterName

String filterName

The name of the subscription filter to delete.

logGroupName

String logGroupName

The name of the log group that is associated with the subscription filter to delete.

Class com.amazonaws.services.logs.model.DeleteSubscriptionFilterResult

class DeleteSubscriptionFilterResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.DescribeDestinationsRequest

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

limit

Integer limit

nextToken

String nextToken

Class com.amazonaws.services.logs.model.DescribeDestinationsResult

class DescribeDestinationsResult extends Object implements Serializable

Serialized Fields

destinations

com.amazonaws.internal.SdkInternalList<Destination> destinations

nextToken

String nextToken

Class com.amazonaws.services.logs.model.DescribeExportTasksRequest

class DescribeExportTasksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

statusCode

String statusCode

All export tasks that matches the specified status code will be returned. This can return zero or more export tasks.

taskId

String taskId

Export task that matches the specified task Id will be returned. This can result in zero or one export task.

Class com.amazonaws.services.logs.model.DescribeExportTasksResult

class DescribeExportTasksResult extends Object implements Serializable

Serialized Fields

exportTasks

com.amazonaws.internal.SdkInternalList<ExportTask> exportTasks

nextToken

String nextToken

Class com.amazonaws.services.logs.model.DescribeLogGroupsRequest

class DescribeLogGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.logs.model.DescribeLogGroupsResult

class DescribeLogGroupsResult extends Object implements Serializable

Serialized Fields

logGroups

com.amazonaws.internal.SdkInternalList<LogGroup> logGroups

nextToken

String nextToken

Class com.amazonaws.services.logs.model.DescribeLogStreamsRequest

class DescribeLogStreamsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

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.

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.

Class com.amazonaws.services.logs.model.DescribeLogStreamsResult

class DescribeLogStreamsResult extends Object implements Serializable

Serialized Fields

logStreams

com.amazonaws.internal.SdkInternalList<LogStream> logStreams

nextToken

String nextToken

Class com.amazonaws.services.logs.model.DescribeMetricFiltersRequest

class DescribeMetricFiltersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

logGroupName

String logGroupName

The log group name for which metric filters are to be listed.

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.

Class com.amazonaws.services.logs.model.DescribeMetricFiltersResult

class DescribeMetricFiltersResult extends Object implements Serializable

Serialized Fields

metricFilters

com.amazonaws.internal.SdkInternalList<MetricFilter> metricFilters

nextToken

String nextToken

Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersRequest

class DescribeSubscriptionFiltersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

limit

Integer limit

logGroupName

String logGroupName

The log group name for which subscription filters are to be listed.

nextToken

String nextToken

Class com.amazonaws.services.logs.model.DescribeSubscriptionFiltersResult

class DescribeSubscriptionFiltersResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

subscriptionFilters

com.amazonaws.internal.SdkInternalList<SubscriptionFilter> subscriptionFilters

Class com.amazonaws.services.logs.model.Destination

class Destination extends Object implements Serializable

Serialized Fields

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.

destinationName

String destinationName

Name of the destination.

roleArn

String roleArn

A role for impersonation for delivering log events to the target.

targetArn

String targetArn

ARN of the physical target where the log events will be delivered (eg. ARN of a Kinesis stream).

Class com.amazonaws.services.logs.model.ExportTask

class ExportTask extends Object implements Serializable

Serialized Fields

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.

executionInfo

ExportTaskExecutionInfo executionInfo

Execution info about the export task.

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.

logGroupName

String logGroupName

The name of the log group from which logs data was exported.

status

ExportTaskStatus status

Status of the export task.

taskId

String taskId

Id of the export task.

taskName

String taskName

The name of the export task.

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.

Class com.amazonaws.services.logs.model.ExportTaskExecutionInfo

class ExportTaskExecutionInfo extends Object implements Serializable

Serialized Fields

completionTime

Long completionTime

A point in time when the export task got completed.

creationTime

Long creationTime

A point in time when the export task got created.

Class com.amazonaws.services.logs.model.ExportTaskStatus

class 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

class FilteredLogEvent extends Object implements Serializable

Serialized Fields

eventId

String eventId

A unique identifier for this event.

ingestionTime

Long ingestionTime

logStreamName

String logStreamName

The name of the log stream this event belongs to.

message

String message

The data contained in the log event.

timestamp

Long timestamp

Class com.amazonaws.services.logs.model.FilterLogEventsRequest

class FilterLogEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

limit

Integer limit

The maximum number of events to return in a page of results. Default is 10,000 events.

logGroupName

String logGroupName

The name of the log group to query.

logStreamNames

com.amazonaws.internal.SdkInternalList<String> logStreamNames

Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

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.

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.

Class com.amazonaws.services.logs.model.FilterLogEventsResult

class FilterLogEventsResult extends Object implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalList<FilteredLogEvent> events

A list of FilteredLogEvent objects representing the matched events from the request.

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.

searchedLogStreams

com.amazonaws.internal.SdkInternalList<SearchedLogStream> 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.

Class com.amazonaws.services.logs.model.GetLogEventsRequest

class GetLogEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

endTime

Long endTime

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.

logGroupName

String logGroupName

The name of the log group to query.

logStreamName

String logStreamName

The name of the log stream to query.

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.

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

startTime

Long startTime

Class com.amazonaws.services.logs.model.GetLogEventsResult

class GetLogEventsResult extends Object implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalList<OutputLogEvent> events

nextBackwardToken

String nextBackwardToken

nextForwardToken

String nextForwardToken

Class com.amazonaws.services.logs.model.InputLogEvent

class InputLogEvent extends Object implements Serializable

Serialized Fields

message

String message

timestamp

Long timestamp

Exception Class com.amazonaws.services.logs.model.InvalidOperationException

class InvalidOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.logs.model.InvalidParameterException

class InvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.logs.model.InvalidSequenceTokenException

class InvalidSequenceTokenException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

expectedSequenceToken

String expectedSequenceToken

Exception Class com.amazonaws.services.logs.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.LogGroup

class LogGroup extends Object implements Serializable

Serialized Fields

arn

String arn

creationTime

Long creationTime

logGroupName

String logGroupName

metricFilterCount

Integer metricFilterCount

retentionInDays

Integer retentionInDays

storedBytes

Long storedBytes

Class com.amazonaws.services.logs.model.LogStream

class LogStream extends Object implements Serializable

Serialized Fields

arn

String arn

creationTime

Long creationTime

firstEventTimestamp

Long firstEventTimestamp

lastEventTimestamp

Long lastEventTimestamp

lastIngestionTime

Long lastIngestionTime

logStreamName

String logStreamName

storedBytes

Long storedBytes

uploadSequenceToken

String uploadSequenceToken

Class com.amazonaws.services.logs.model.MetricFilter

class MetricFilter extends Object implements Serializable

Serialized Fields

creationTime

Long creationTime

filterName

String filterName

filterPattern

String filterPattern

metricTransformations

com.amazonaws.internal.SdkInternalList<MetricTransformation> metricTransformations

Class com.amazonaws.services.logs.model.MetricFilterMatchRecord

class MetricFilterMatchRecord extends Object implements Serializable

Serialized Fields

eventMessage

String eventMessage

eventNumber

Long eventNumber

extractedValues

com.amazonaws.internal.SdkInternalMap<String,String> extractedValues

Class com.amazonaws.services.logs.model.MetricTransformation

class MetricTransformation extends Object implements Serializable

Serialized Fields

metricName

String metricName

metricNamespace

String metricNamespace

metricValue

String metricValue

Exception Class com.amazonaws.services.logs.model.OperationAbortedException

class OperationAbortedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.OutputLogEvent

class OutputLogEvent extends Object implements Serializable

Serialized Fields

ingestionTime

Long ingestionTime

message

String message

timestamp

Long timestamp

Class com.amazonaws.services.logs.model.PutDestinationPolicyRequest

class PutDestinationPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

accessPolicy

String accessPolicy

An IAM policy document that authorizes cross-account users to deliver their log events to associated destination.

destinationName

String destinationName

A name for an existing destination.

Class com.amazonaws.services.logs.model.PutDestinationPolicyResult

class PutDestinationPolicyResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.PutDestinationRequest

class PutDestinationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

destinationName

String destinationName

A name for the destination.

roleArn

String roleArn

The ARN of an IAM role that grants CloudWatch Logs permissions to do Amazon Kinesis PutRecord requests on the desitnation stream.

targetArn

String targetArn

The ARN of an Amazon Kinesis stream to deliver matching log events to.

Class com.amazonaws.services.logs.model.PutDestinationResult

class PutDestinationResult extends Object implements Serializable

Serialized Fields

destination

Destination destination

Class com.amazonaws.services.logs.model.PutLogEventsRequest

class PutLogEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

logEvents

com.amazonaws.internal.SdkInternalList<InputLogEvent> logEvents

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.

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

class PutLogEventsResult extends Object implements Serializable

Serialized Fields

nextSequenceToken

String nextSequenceToken

rejectedLogEventsInfo

RejectedLogEventsInfo rejectedLogEventsInfo

Class com.amazonaws.services.logs.model.PutMetricFilterRequest

class PutMetricFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

logGroupName

String logGroupName

The name of the log group to associate the metric filter with.

metricTransformations

com.amazonaws.internal.SdkInternalList<MetricTransformation> metricTransformations

A collection of information needed to define how metric data gets emitted.

Class com.amazonaws.services.logs.model.PutMetricFilterResult

class PutMetricFilterResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.PutRetentionPolicyRequest

class 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.PutRetentionPolicyResult

class PutRetentionPolicyResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.PutSubscriptionFilterRequest

class PutSubscriptionFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

logGroupName

String logGroupName

The name of the log group to associate the subscription filter with.

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

class PutSubscriptionFilterResult extends Object implements Serializable

Class com.amazonaws.services.logs.model.RejectedLogEventsInfo

class RejectedLogEventsInfo extends Object implements Serializable

Serialized Fields

expiredLogEventEndIndex

Integer expiredLogEventEndIndex

tooNewLogEventStartIndex

Integer tooNewLogEventStartIndex

tooOldLogEventEndIndex

Integer tooOldLogEventEndIndex

Exception Class com.amazonaws.services.logs.model.ResourceAlreadyExistsException

class ResourceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.logs.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.SearchedLogStream

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

Exception Class com.amazonaws.services.logs.model.ServiceUnavailableException

class ServiceUnavailableException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.logs.model.SubscriptionFilter

class SubscriptionFilter extends Object implements Serializable

Serialized Fields

creationTime

Long creationTime

destinationArn

String destinationArn

filterName

String filterName

filterPattern

String filterPattern

logGroupName

String logGroupName

roleArn

String roleArn

Class com.amazonaws.services.logs.model.TestMetricFilterRequest

class TestMetricFilterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filterPattern

String filterPattern

logEventMessages

com.amazonaws.internal.SdkInternalList<String> logEventMessages

A list of log event messages to test.

Class com.amazonaws.services.logs.model.TestMetricFilterResult

class TestMetricFilterResult extends Object implements Serializable

Serialized Fields

matches

com.amazonaws.internal.SdkInternalList<MetricFilterMatchRecord> matches

Package com.amazonaws.services.machinelearning.model

Class com.amazonaws.services.machinelearning.model.BatchPrediction

class BatchPrediction extends Object implements Serializable

Serialized Fields

batchPredictionDataSourceId

String batchPredictionDataSourceId

The ID of the DataSource that points to the group of observations to predict.

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.

createdAt

Date createdAt

The time that the BatchPrediction was created. The time is expressed in epoch time.

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.

inputDataLocationS3

String inputDataLocationS3

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

message

String message

A description of the most recent details about processing the batch prediction request.

mLModelId

String mLModelId

The ID of the MLModel that generated predictions for the BatchPrediction request.

name

String name

A user-supplied name or description of the BatchPrediction.

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: ':', '//', '/./', '/../'.

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.

Class com.amazonaws.services.machinelearning.model.CreateBatchPredictionRequest

class CreateBatchPredictionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

batchPredictionDataSourceId

String batchPredictionDataSourceId

The ID of the DataSource that points to the group of observations to predict.

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.

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

class 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

class CreateDataSourceFromRDSRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRDSResult

class 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

class CreateDataSourceFromRedshiftRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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

Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromRedshiftResult

class 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

class CreateDataSourceFromS3Request extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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

Class com.amazonaws.services.machinelearning.model.CreateDataSourceFromS3Result

class 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

class CreateEvaluationRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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 .

Class com.amazonaws.services.machinelearning.model.CreateEvaluationResult

class 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

class 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<String,String> 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.

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.

trainingDataSourceId

String trainingDataSourceId

The DataSource that points to the training data.

Class com.amazonaws.services.machinelearning.model.CreateMLModelResult

class 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

class 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

class 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

class DataSource extends Object implements Serializable

Serialized Fields

computeStatistics

Boolean computeStatistics

The parameter is true if statistics need to be generated from the observation data.

createdAt

Date createdAt

The time that the DataSource was created. The time is expressed in epoch time.

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.

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.

dataSizeInBytes

Long dataSizeInBytes

The total number of observations contained in the data files that the DataSource references.

dataSourceId

String dataSourceId

The ID that is assigned to the DataSource during creation.

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

message

String message

A description of the most recent details about creating the DataSource.

name

String name

A user-supplied name or description of the DataSource.

numberOfFiles

Long numberOfFiles

The number of data files referenced by the DataSource.

rDSMetadata

RDSMetadata rDSMetadata

redshiftMetadata

RedshiftMetadata redshiftMetadata

roleARN

String roleARN

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.

Class com.amazonaws.services.machinelearning.model.DeleteBatchPredictionRequest

class 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

class 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

class 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

class 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

class 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

class 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

class 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

class 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

class 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

class 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

class DescribeBatchPredictionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eQ

String eQ

The equal to operator. The BatchPrediction results will have FilterVariable values that exactly match the value specified with EQ.

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.

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.

gT

String gT

The greater than operator. The BatchPrediction results will have FilterVariable values that are greater than the value specified with GT.

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.

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.

lT

String lT

The less than operator. The BatchPrediction results will have FilterVariable values that are less than the value specified with LT.

nE

String nE

The not equal to operator. The BatchPrediction results will have FilterVariable values not equal to the value specified with NE.

nextToken

String nextToken

An ID of the page in the paginated results.

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.

Class com.amazonaws.services.machinelearning.model.DescribeBatchPredictionsResult

class DescribeBatchPredictionsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The ID of the next page in the paginated results that indicates at least one more page follows.

results

com.amazonaws.internal.SdkInternalList<BatchPrediction> results

A list of BatchPrediction objects that meet the search criteria.

Class com.amazonaws.services.machinelearning.model.DescribeDataSourcesRequest

class DescribeDataSourcesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eQ

String eQ

The equal to operator. The DataSource results will have FilterVariable values that exactly match the value specified with EQ.

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.

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.

gT

String gT

The greater than operator. The DataSource results will have FilterVariable values that are greater than the value specified with GT.

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.

limit

Integer limit

The maximum number of DataSource to include in the result.

lT

String lT

The less than operator. The DataSource results will have FilterVariable values that are less than the value specified with LT.

nE

String nE

The not equal to operator. The DataSource results will have FilterVariable values not equal to the value specified with NE.

nextToken

String nextToken

The ID of the page in the paginated results.

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.

Class com.amazonaws.services.machinelearning.model.DescribeDataSourcesResult

class DescribeDataSourcesResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

An ID of the next page in the paginated results that indicates at least one more page follows.

results

com.amazonaws.internal.SdkInternalList<DataSource> results

A list of DataSource that meet the search criteria.

Class com.amazonaws.services.machinelearning.model.DescribeEvaluationsRequest

class DescribeEvaluationsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eQ

String eQ

The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

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.

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.

gT

String gT

The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

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.

limit

Integer limit

The maximum number of Evaluation to include in the result.

lT

String lT

The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

nE

String nE

The not equal to operator. The Evaluation results will have FilterVariable values not equal to the value specified with NE.

nextToken

String nextToken

The ID of the page in the paginated results.

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.

Class com.amazonaws.services.machinelearning.model.DescribeEvaluationsResult

class DescribeEvaluationsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The ID of the next page in the paginated results that indicates at least one more page follows.

results

com.amazonaws.internal.SdkInternalList<Evaluation> results

A list of Evaluation that meet the search criteria.

Class com.amazonaws.services.machinelearning.model.DescribeMLModelsRequest

class DescribeMLModelsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

eQ

String eQ

The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.

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.

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.

gT

String gT

The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.

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.

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.

lT

String lT

The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.

nE

String nE

The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.

nextToken

String nextToken

The ID of the page in the paginated results.

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.

Class com.amazonaws.services.machinelearning.model.DescribeMLModelsResult

class DescribeMLModelsResult extends Object implements Serializable

Serialized Fields

nextToken

String nextToken

The ID of the next page in the paginated results that indicates at least one more page follows.

results

com.amazonaws.internal.SdkInternalList<MLModel> results

A list of MLModel that meet the search criteria.

Class com.amazonaws.services.machinelearning.model.Evaluation

class Evaluation extends Object implements Serializable

Serialized Fields

createdAt

Date createdAt

The time that the Evaluation was created. The time is expressed in epoch time.

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.

evaluationDataSourceId

String evaluationDataSourceId

The ID of the DataSource that is used to evaluate the MLModel.

evaluationId

String evaluationId

The ID that is assigned to the Evaluation at creation.

inputDataLocationS3

String inputDataLocationS3

The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to the Evaluation. The time is expressed in epoch time.

message

String message

A description of the most recent details about evaluating the MLModel.

mLModelId

String mLModelId

The ID of the MLModel that is the focus of the evaluation.

name

String name

A user-supplied name or description of the Evaluation.

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.

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.

Class com.amazonaws.services.machinelearning.model.GetBatchPredictionRequest

class 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

class GetBatchPredictionResult extends Object implements Serializable

Serialized Fields

batchPredictionDataSourceId

String batchPredictionDataSourceId

The ID of the DataSource that was used to create the BatchPrediction.

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.

createdAt

Date createdAt

The time when the BatchPrediction was created. The time is expressed in epoch time.

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.

inputDataLocationS3

String inputDataLocationS3

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to BatchPrediction. The time is expressed in epoch time.

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.

mLModelId

String mLModelId

The ID of the MLModel that generated predictions for the BatchPrediction request.

name

String name

A user-supplied name or description of the BatchPrediction.

outputUri

String outputUri

The location of an Amazon S3 bucket or directory to receive the operation results.

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.

Class com.amazonaws.services.machinelearning.model.GetDataSourceRequest

class 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

class GetDataSourceResult extends Object implements Serializable

Serialized Fields

computeStatistics

Boolean computeStatistics

The parameter is true if statistics need to be generated from the observation data.

createdAt

Date createdAt

The time that the DataSource was created. The time is expressed in epoch time.

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.

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.

dataSizeInBytes

Long dataSizeInBytes

The total size of observations in the data files.

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.

dataSourceSchema

String dataSourceSchema

The schema used by all of the data files of this DataSource.

This parameter is provided as part of the verbose format.

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to the DataSource. The time is expressed in epoch time.

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.

name

String name

A user-supplied name or description of the DataSource.

numberOfFiles

Long numberOfFiles

The number of data files referenced by the DataSource.

rDSMetadata

RDSMetadata rDSMetadata

redshiftMetadata

RedshiftMetadata redshiftMetadata

roleARN

String roleARN

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.

Class com.amazonaws.services.machinelearning.model.GetEvaluationRequest

class 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

class GetEvaluationResult extends Object implements Serializable

Serialized Fields

createdAt

Date createdAt

The time that the Evaluation was created. The time is expressed in epoch time.

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.

evaluationDataSourceId

String evaluationDataSourceId

The DataSource used for this evaluation.

evaluationId

String evaluationId

The evaluation ID which is same as the EvaluationId in the request.

inputDataLocationS3

String inputDataLocationS3

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to the BatchPrediction. The time is expressed in epoch time.

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.

mLModelId

String mLModelId

The ID of the MLModel that was the focus of the evaluation.

name

String name

A user-supplied name or description of the Evaluation.

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.

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.

Class com.amazonaws.services.machinelearning.model.GetMLModelRequest

class 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

class GetMLModelResult extends Object implements Serializable

Serialized Fields

createdAt

Date createdAt

The time that the MLModel was created. The time is expressed in epoch time.

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.

endpointInfo

RealtimeEndpointInfo endpointInfo

The current endpoint of the MLModel

inputDataLocationS3

String inputDataLocationS3

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to the MLModel. 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.

mLModelId

String mLModelId

The MLModel ID which is same as the MLModelId in the request.

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

name

String name

A user-supplied name or description of 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.

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.

This parameter is provided as part of the verbose format.

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.

sizeInBytes

Long sizeInBytes

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.

trainingDataSourceId

String trainingDataSourceId

The ID of the training DataSource.

trainingParameters

com.amazonaws.internal.SdkInternalMap<String,String> 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.

Exception Class com.amazonaws.services.machinelearning.model.IdempotentParameterMismatchException

class IdempotentParameterMismatchException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

Exception Class com.amazonaws.services.machinelearning.model.InternalServerException

class InternalServerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

Exception Class com.amazonaws.services.machinelearning.model.InvalidInputException

class InvalidInputException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

Exception Class com.amazonaws.services.machinelearning.model.LimitExceededException

class LimitExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

Class com.amazonaws.services.machinelearning.model.MLModel

class MLModel extends Object implements Serializable

Serialized Fields

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.

createdAt

Date createdAt

The time that the MLModel was created. The time is expressed in epoch time.

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.

endpointInfo

RealtimeEndpointInfo endpointInfo

The current endpoint of the MLModel.

inputDataLocationS3

String inputDataLocationS3

The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).

lastUpdatedAt

Date lastUpdatedAt

The time of the most recent edit to the MLModel. The time is expressed in epoch time.

message

String message

A description of the most recent details about accessing the MLModel.

mLModelId

String mLModelId

The ID assigned to the MLModel at creation.

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?".

name

String name

A user-supplied name or description of the MLModel.

scoreThreshold

Float scoreThreshold

scoreThresholdLastUpdatedAt

Date scoreThresholdLastUpdatedAt

The time of the most recent edit to the ScoreThreshold. The time is expressed in epoch time.

sizeInBytes

Long sizeInBytes

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.

trainingDataSourceId

String trainingDataSourceId

The ID of the training DataSource. The CreateMLModel operation uses the TrainingDataSourceId.

trainingParameters

com.amazonaws.internal.SdkInternalMap<String,String> 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.

Class com.amazonaws.services.machinelearning.model.PerformanceMetrics

class PerformanceMetrics extends Object implements Serializable

Serialized Fields

properties

com.amazonaws.internal.SdkInternalMap<String,String> properties

Class com.amazonaws.services.machinelearning.model.Prediction

class Prediction extends Object implements Serializable

Serialized Fields

details

com.amazonaws.internal.SdkInternalMap<String,String> details

predictedLabel

String predictedLabel

The prediction label for either a BINARY or MULTICLASS MLModel.

predictedScores

com.amazonaws.internal.SdkInternalMap<String,Float> predictedScores

predictedValue

Float predictedValue

The prediction value for REGRESSION MLModel.

Exception Class com.amazonaws.services.machinelearning.model.PredictorNotMountedException

class PredictorNotMountedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.machinelearning.model.PredictRequest

class PredictRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mLModelId

String mLModelId

A unique identifier of the MLModel.

predictEndpoint

String predictEndpoint

record

com.amazonaws.internal.SdkInternalMap<String,String> record

Class com.amazonaws.services.machinelearning.model.PredictResult

class PredictResult extends Object implements Serializable

Serialized Fields

prediction

Prediction prediction

Class com.amazonaws.services.machinelearning.model.RDSDatabase

class RDSDatabase extends Object implements Serializable

Serialized Fields

databaseName

String databaseName

instanceIdentifier

String instanceIdentifier

The ID of an RDS DB instance.

Class com.amazonaws.services.machinelearning.model.RDSDatabaseCredentials

class RDSDatabaseCredentials extends Object implements Serializable

Serialized Fields

password

String password

username

String username

Class com.amazonaws.services.machinelearning.model.RDSDataSpec

class RDSDataSpec extends Object implements Serializable

Serialized Fields

databaseCredentials

RDSDatabaseCredentials databaseCredentials

The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

databaseInformation

RDSDatabase databaseInformation

Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

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" ] }

invalid input: '<'?oxy_insert_end>

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.

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.

securityGroupIds

com.amazonaws.internal.SdkInternalList<String> 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.

selectSqlQuery

String selectSqlQuery

The query that is used to retrieve the observation data for the DataSource.

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.

Class com.amazonaws.services.machinelearning.model.RDSMetadata

class RDSMetadata extends Object implements Serializable

Serialized Fields

database

RDSDatabase database

The database details required to connect to an Amazon RDS.

databaseUserName

String databaseUserName

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.

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.

selectSqlQuery

String selectSqlQuery

The SQL query that is supplied during CreateDataSourceFromRDS. Returns only if Verbose is true in GetDataSourceInput.

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.

Class com.amazonaws.services.machinelearning.model.RealtimeEndpointInfo

class RealtimeEndpointInfo extends Object implements Serializable

Serialized Fields

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.

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.

endpointUrl

String endpointUrl

The URI that specifies where to send real-time prediction requests for the MLModel.

The application must wait until the real-time endpoint is ready before using this URI.

peakRequestsPerSecond

Integer peakRequestsPerSecond

The maximum processing rate for the real-time endpoint for MLModel, measured in incoming requests per second.

Class com.amazonaws.services.machinelearning.model.RedshiftDatabase

class RedshiftDatabase extends Object implements Serializable

Serialized Fields

clusterIdentifier

String clusterIdentifier

databaseName

String databaseName

Class com.amazonaws.services.machinelearning.model.RedshiftDatabaseCredentials

class RedshiftDatabaseCredentials extends Object implements Serializable

Serialized Fields

password

String password

username

String username

Class com.amazonaws.services.machinelearning.model.RedshiftDataSpec

class RedshiftDataSpec extends Object implements Serializable

Serialized Fields

databaseCredentials

RedshiftDatabaseCredentials databaseCredentials

Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.

databaseInformation

RedshiftDatabase databaseInformation

Describes the DatabaseName and ClusterIdentifier for an Amazon Redshift DataSource.

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.

s3StagingLocation

String s3StagingLocation

Describes an Amazon S3 location to store the result set of the SelectSqlQuery query.

selectSqlQuery

String selectSqlQuery

Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift DataSource.

Class com.amazonaws.services.machinelearning.model.RedshiftMetadata

class RedshiftMetadata extends Object implements Serializable

Serialized Fields

databaseUserName

String databaseUserName

redshiftDatabase

RedshiftDatabase redshiftDatabase

selectSqlQuery

String selectSqlQuery

The SQL query that is specified during CreateDataSourceFromRedshift. Returns only if Verbose is true in GetDataSourceInput.

Exception Class com.amazonaws.services.machinelearning.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

code

Integer code

Class com.amazonaws.services.machinelearning.model.S3DataSpec

class 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" ] }

invalid input: '<'?oxy_insert_end>

dataSchemaLocationS3

String dataSchemaLocationS3

Describes the schema Location in Amazon S3.

Class com.amazonaws.services.machinelearning.model.UpdateBatchPredictionRequest

class 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

class 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

class 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

class 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

class 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

class 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

class 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

class 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

class GenerateDataSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

customerDefinedValues

Map<String,String> 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.

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

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.

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.

roleNameArn

String roleNameArn

The Amazon Resource Name (ARN) of the Role with an attached permissions policy to interact with the provided AWS services.

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.

Class com.amazonaws.services.marketplacecommerceanalytics.model.GenerateDataSetResult

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

Exception Class com.amazonaws.services.marketplacecommerceanalytics.model.MarketplaceCommerceAnalyticsException

class MarketplaceCommerceAnalyticsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.marketplacemetering.model

Exception Class com.amazonaws.services.marketplacemetering.model.DuplicateRequestException

class DuplicateRequestException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.marketplacemetering.model.InternalServiceErrorException

class InternalServiceErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.marketplacemetering.model.InvalidEndpointRegionException

class InvalidEndpointRegionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.marketplacemetering.model.InvalidProductCodeException

class InvalidProductCodeException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.marketplacemetering.model.InvalidUsageDimensionException

class InvalidUsageDimensionException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.marketplacemetering.model.MeterUsageRequest

class MeterUsageRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

Class com.amazonaws.services.marketplacemetering.model.MeterUsageResult

class MeterUsageResult extends Object implements Serializable

Serialized Fields

meteringRecordId

String meteringRecordId

Exception Class com.amazonaws.services.marketplacemetering.model.ThrottlingException

class ThrottlingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.marketplacemetering.model.TimestampOutOfBoundsException

class TimestampOutOfBoundsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Package com.amazonaws.services.opsworks.model

Class com.amazonaws.services.opsworks.model.AgentVersion

class AgentVersion extends Object implements Serializable

Serialized Fields

configurationManager

StackConfigurationManager configurationManager

The configuration manager.

version

String version

The agent version.

Class com.amazonaws.services.opsworks.model.App

class App extends Object implements Serializable

Serialized Fields

appId

String appId

The app ID.

appSource

Source appSource

A Source object that describes the app repository.

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

The stack attributes.

createdAt

String createdAt

When the app was created.

dataSources

com.amazonaws.internal.SdkInternalList<DataSource> dataSources

The app's data sources.

description

String description

A description of the app.

domains

com.amazonaws.internal.SdkInternalList<String> 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.

environment

com.amazonaws.internal.SdkInternalList<EnvironmentVariable> 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.

name

String name

The app name.

shortname

String shortname

The app's short name.

sslConfiguration

SslConfiguration sslConfiguration

An SslConfiguration object with the SSL configuration.

stackId

String stackId

The app stack ID.

type

String type

The app type.

Class com.amazonaws.services.opsworks.model.AssignInstanceRequest

class AssignInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

layerIds

com.amazonaws.internal.SdkInternalList<String> 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.AssignInstanceResult

class AssignInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.AssignVolumeRequest

class AssignVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

volumeId

String volumeId

The volume ID.

Class com.amazonaws.services.opsworks.model.AssignVolumeResult

class AssignVolumeResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.AssociateElasticIpRequest

class 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.AssociateElasticIpResult

class AssociateElasticIpResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.AttachElasticLoadBalancerRequest

class 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.AttachElasticLoadBalancerResult

class AttachElasticLoadBalancerResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.AutoScalingThresholds

class AutoScalingThresholds extends Object implements Serializable

Serialized Fields

alarms

com.amazonaws.internal.SdkInternalList<String> 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.

cpuThreshold

Double cpuThreshold

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

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.

instanceCount

Integer instanceCount

The number of instances to add or remove when the load exceeds a 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).

memoryThreshold

Double memoryThreshold

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

thresholdsWaitTime

Integer thresholdsWaitTime

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

Class com.amazonaws.services.opsworks.model.BlockDeviceMapping

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

ebs

EbsBlockDevice ebs

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

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.

Class com.amazonaws.services.opsworks.model.ChefConfiguration

class ChefConfiguration extends Object implements Serializable

Serialized Fields

berkshelfVersion

String berkshelfVersion

The Berkshelf version.

manageBerkshelf

Boolean manageBerkshelf

Whether to enable Berkshelf.

Class com.amazonaws.services.opsworks.model.CloneStackRequest

class CloneStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

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.

cloneAppIds

com.amazonaws.internal.SdkInternalList<String> cloneAppIds

A list of source stack app IDs to be included in the cloned stack.

clonePermissions

Boolean clonePermissions

Whether to clone the source stack's permissions.

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.

customCookbooksSource

Source customCookbooksSource

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

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.

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.

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.

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.

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.

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.

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.

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.

sourceStackId

String sourceStackId

The source stack ID.

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.

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.

Class com.amazonaws.services.opsworks.model.CloneStackResult

class CloneStackResult extends Object implements Serializable

Serialized Fields

stackId

String stackId

The cloned stack ID.

Class com.amazonaws.services.opsworks.model.Command

class Command extends Object implements Serializable

Serialized Fields

acknowledgedAt

String acknowledgedAt

Date and time when the command was acknowledged.

commandId

String commandId

The command ID.

completedAt

String completedAt

Date when the command completed.

createdAt

String createdAt

Date and time when the command was run.

deploymentId

String deploymentId

The command deployment ID.

exitCode

Integer exitCode

The command exit code.

instanceId

String instanceId

The ID of the instance where the command was executed.

logUrl

String logUrl

The URL of the command log.

status

String status

The command status:

• failed
• successful
• skipped
• pending

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

class CreateAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appSource

Source appSource

A Source object that specifies the app repository.

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

One or more user-defined key/value pairs to be added to the stack attributes.

dataSources

com.amazonaws.internal.SdkInternalList<DataSource> dataSources

The app's data source.

description

String description

A description of the app.

domains

com.amazonaws.internal.SdkInternalList<String> 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.

environment

com.amazonaws.internal.SdkInternalList<EnvironmentVariable> 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.

name

String name

The app name.

shortname

String shortname

The app's short name.

sslConfiguration

SslConfiguration sslConfiguration

An SslConfiguration object with the SSL configuration.

stackId

String stackId

The stack ID.

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.

Class com.amazonaws.services.opsworks.model.CreateAppResult

class CreateAppResult extends Object implements Serializable

Serialized Fields

appId

String appId

The app ID.

Class com.amazonaws.services.opsworks.model.CreateDeploymentRequest

class CreateDeploymentRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appId

String appId

The app ID. This parameter is required for app deployments, but not for other deployment commands.

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.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

The instance IDs for the deployment targets.

layerIds

com.amazonaws.internal.SdkInternalList<String> layerIds

The layer IDs for the deployment targets.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.CreateDeploymentResult

class 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

class CreateInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

autoScalingType

String autoScalingType

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

availabilityZone

String availabilityZone

The instance Availability Zone. For more information, see Regions and Endpoints.

blockDeviceMappings

com.amazonaws.internal.SdkInternalList<BlockDeviceMapping> 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.

ebsOptimized

Boolean ebsOptimized

Whether to create an Amazon EBS-optimized instance.

hostname

String hostname

The instance host name.

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.

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.

layerIds

com.amazonaws.internal.SdkInternalList<String> layerIds

An array that contains the instance's layer IDs.

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.

rootDeviceType

String rootDeviceType

The instance root device type. For more information, see Storage for the Root Device.

sshKeyName

String sshKeyName

The instance's Amazon EC2 key-pair name.

stackId

String stackId

The stack ID.

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.

tenancy

String tenancy

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

virtualizationType

String virtualizationType

The instance's virtualization type, paravirtual or hvm.

Class com.amazonaws.services.opsworks.model.CreateInstanceResult

class CreateInstanceResult extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.CreateLayerRequest

class CreateLayerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.SdkInternalMap<String,String> 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.

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.

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.

customRecipes

Recipes customRecipes

A LayerCustomRecipes object that specifies the layer custom recipes.

customSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> customSecurityGroupIds

An array containing the layer custom security group IDs.

enableAutoHealing

Boolean enableAutoHealing

Whether to disable auto healing for the layer.

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.

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.

name

String name

The layer name, which is used by the console.

packages

com.amazonaws.internal.SdkInternalList<String> packages

An array of Package objects that describes the layer packages.

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.

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.

useEbsOptimizedInstances

Boolean useEbsOptimizedInstances

Whether to use Amazon EBS-optimized instances.

volumeConfigurations

com.amazonaws.internal.SdkInternalList<VolumeConfiguration> volumeConfigurations

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Class com.amazonaws.services.opsworks.model.CreateLayerResult

class CreateLayerResult extends Object implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

Class com.amazonaws.services.opsworks.model.CreateStackRequest

class CreateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

One or more user-defined key-value pairs to be added to the stack attributes.

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.

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.

customCookbooksSource

Source customCookbooksSource

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Class com.amazonaws.services.opsworks.model.CreateStackResult

class 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

class CreateUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

iamUserArn

String iamUserArn

The user's IAM ARN.

sshPublicKey

String sshPublicKey

The user's public SSH key.

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.

Class com.amazonaws.services.opsworks.model.CreateUserProfileResult

class CreateUserProfileResult extends Object implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user's IAM ARN.

Class com.amazonaws.services.opsworks.model.DataSource

class DataSource extends Object implements Serializable

Serialized Fields

arn

String arn

The data source's ARN.

databaseName

String databaseName

The database name.

type

String type

The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.

Class com.amazonaws.services.opsworks.model.DeleteAppRequest

class DeleteAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appId

String appId

The app ID.

Class com.amazonaws.services.opsworks.model.DeleteAppResult

class DeleteAppResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeleteInstanceRequest

class DeleteInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

deleteElasticIp

Boolean deleteElasticIp

Whether to delete the instance Elastic IP address.

deleteVolumes

Boolean deleteVolumes

Whether to delete the instance's Amazon EBS volumes.

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.DeleteInstanceResult

class DeleteInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeleteLayerRequest

class DeleteLayerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

Class com.amazonaws.services.opsworks.model.DeleteLayerResult

class DeleteLayerResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeleteStackRequest

class DeleteStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.DeleteStackResult

class DeleteStackResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeleteUserProfileRequest

class DeleteUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user's IAM ARN.

Class com.amazonaws.services.opsworks.model.DeleteUserProfileResult

class DeleteUserProfileResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.Deployment

class Deployment extends Object implements Serializable

Serialized Fields

appId

String appId

The app ID.

command

DeploymentCommand command

comment

String comment

A user-defined comment.

completedAt

String completedAt

Date when the deployment completed.

createdAt

String createdAt

Date when the deployment was created.

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.

deploymentId

String deploymentId

The deployment ID.

duration

Integer duration

The deployment duration.

iamUserArn

String iamUserArn

The user's IAM ARN.

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

The IDs of the target instances.

stackId

String stackId

The stack ID.

status

String status

The deployment status:

• running
• successful
• failed

Class com.amazonaws.services.opsworks.model.DeploymentCommand

class DeploymentCommand extends Object implements Serializable

Serialized Fields

args

com.amazonaws.internal.SdkInternalMap<String, List<String>> 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"] }

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.

Class com.amazonaws.services.opsworks.model.DeregisterEcsClusterRequest

class DeregisterEcsClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ecsClusterArn

String ecsClusterArn

The cluster's ARN.

Class com.amazonaws.services.opsworks.model.DeregisterEcsClusterResult

class DeregisterEcsClusterResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeregisterElasticIpRequest

class DeregisterElasticIpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

elasticIp

String elasticIp

The Elastic IP address.

Class com.amazonaws.services.opsworks.model.DeregisterElasticIpResult

class DeregisterElasticIpResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeregisterInstanceRequest

class DeregisterInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.DeregisterInstanceResult

class DeregisterInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeregisterRdsDbInstanceRequest

class DeregisterRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

rdsDbInstanceArn

String rdsDbInstanceArn

The Amazon RDS instance's ARN.

Class com.amazonaws.services.opsworks.model.DeregisterRdsDbInstanceResult

class DeregisterRdsDbInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DeregisterVolumeRequest

class 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.DeregisterVolumeResult

class DeregisterVolumeResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DescribeAgentVersionsRequest

class DescribeAgentVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

configurationManager

StackConfigurationManager configurationManager

The configuration manager.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.DescribeAgentVersionsResult

class DescribeAgentVersionsResult extends Object implements Serializable

Serialized Fields

agentVersions

com.amazonaws.internal.SdkInternalList<AgentVersion> 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

class DescribeAppsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appIds

com.amazonaws.internal.SdkInternalList<String> 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.

stackId

String stackId

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

Class com.amazonaws.services.opsworks.model.DescribeAppsResult

class DescribeAppsResult extends Object implements Serializable

Serialized Fields

apps

com.amazonaws.internal.SdkInternalList<App> apps

An array of App objects that describe the specified apps.

Class com.amazonaws.services.opsworks.model.DescribeCommandsRequest

class DescribeCommandsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

commandIds

com.amazonaws.internal.SdkInternalList<String> 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.

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.

Class com.amazonaws.services.opsworks.model.DescribeCommandsResult

class DescribeCommandsResult extends Object implements Serializable

Serialized Fields

commands

com.amazonaws.internal.SdkInternalList<Command> commands

An array of Command objects that describe each of the specified commands.

Class com.amazonaws.services.opsworks.model.DescribeDeploymentsRequest

class DescribeDeploymentsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

stackId

String stackId

The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.

Class com.amazonaws.services.opsworks.model.DescribeDeploymentsResult

class DescribeDeploymentsResult extends Object implements Serializable

Serialized Fields

deployments

com.amazonaws.internal.SdkInternalList<Deployment> deployments

An array of Deployment objects that describe the deployments.

Class com.amazonaws.services.opsworks.model.DescribeEcsClustersRequest

class DescribeEcsClustersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ecsClusterArns

com.amazonaws.internal.SdkInternalList<String> ecsClusterArns

A list of ARNs, one for each cluster to be described.

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.

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.

stackId

String stackId

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

Class com.amazonaws.services.opsworks.model.DescribeEcsClustersResult

class DescribeEcsClustersResult extends Object implements Serializable

Serialized Fields

ecsClusters

com.amazonaws.internal.SdkInternalList<EcsCluster> 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

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

ips

com.amazonaws.internal.SdkInternalList<String> 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.

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.

Class com.amazonaws.services.opsworks.model.DescribeElasticIpsResult

class DescribeElasticIpsResult extends Object implements Serializable

Serialized Fields

elasticIps

com.amazonaws.internal.SdkInternalList<ElasticIp> elasticIps

An ElasticIps object that describes the specified Elastic IP addresses.

Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersRequest

class DescribeElasticLoadBalancersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerIds

com.amazonaws.internal.SdkInternalList<String> layerIds

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

stackId

String stackId

A stack ID. The action describes the stack's Elastic Load Balancing instances.

Class com.amazonaws.services.opsworks.model.DescribeElasticLoadBalancersResult

class DescribeElasticLoadBalancersResult extends Object implements Serializable

Serialized Fields

elasticLoadBalancers

com.amazonaws.internal.SdkInternalList<ElasticLoadBalancer> elasticLoadBalancers

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

Class com.amazonaws.services.opsworks.model.DescribeInstancesRequest

class DescribeInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.SdkInternalList<String> 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.

layerId

String layerId

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

stackId

String stackId

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

Class com.amazonaws.services.opsworks.model.DescribeInstancesResult

class DescribeInstancesResult extends Object implements Serializable

Serialized Fields

instances

com.amazonaws.internal.SdkInternalList<Instance> instances

An array of Instance objects that describe the instances.

Class com.amazonaws.services.opsworks.model.DescribeLayersRequest

class DescribeLayersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerIds

com.amazonaws.internal.SdkInternalList<String> 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.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.DescribeLayersResult

class DescribeLayersResult extends Object implements Serializable

Serialized Fields

layers

com.amazonaws.internal.SdkInternalList<Layer> layers

An array of Layer objects that describe the layers.

Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingRequest

class DescribeLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerIds

com.amazonaws.internal.SdkInternalList<String> layerIds

An array of layer IDs.

Class com.amazonaws.services.opsworks.model.DescribeLoadBasedAutoScalingResult

class DescribeLoadBasedAutoScalingResult extends Object implements Serializable

Serialized Fields

loadBasedAutoScalingConfigurations

com.amazonaws.internal.SdkInternalList<LoadBasedAutoScalingConfiguration> loadBasedAutoScalingConfigurations

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

Class com.amazonaws.services.opsworks.model.DescribeMyUserProfileRequest

class DescribeMyUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.opsworks.model.DescribeMyUserProfileResult

class 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

class 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

class DescribePermissionsResult extends Object implements Serializable

Serialized Fields

permissions

com.amazonaws.internal.SdkInternalList<Permission> 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

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

raidArrayIds

com.amazonaws.internal.SdkInternalList<String> 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.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.DescribeRaidArraysResult

class DescribeRaidArraysResult extends Object implements Serializable

Serialized Fields

raidArrays

com.amazonaws.internal.SdkInternalList<RaidArray> raidArrays

A RaidArrays object that describes the specified RAID arrays.

Class com.amazonaws.services.opsworks.model.DescribeRdsDbInstancesRequest

class DescribeRdsDbInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

rdsDbInstanceArns

com.amazonaws.internal.SdkInternalList<String> rdsDbInstanceArns

An array containing the ARNs of the instances to be described.

stackId

String stackId

The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.

Class com.amazonaws.services.opsworks.model.DescribeRdsDbInstancesResult

class DescribeRdsDbInstancesResult extends Object implements Serializable

Serialized Fields

rdsDbInstances

com.amazonaws.internal.SdkInternalList<RdsDbInstance> rdsDbInstances

An a array of RdsDbInstance objects that describe the instances.

Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsRequest

class DescribeServiceErrorsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

stackId

String stackId

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

Class com.amazonaws.services.opsworks.model.DescribeServiceErrorsResult

class DescribeServiceErrorsResult extends Object implements Serializable

Serialized Fields

serviceErrors

com.amazonaws.internal.SdkInternalList<ServiceError> serviceErrors

An array of ServiceError objects that describe the specified service errors.

Class com.amazonaws.services.opsworks.model.DescribeStackProvisioningParametersRequest

class DescribeStackProvisioningParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID

Class com.amazonaws.services.opsworks.model.DescribeStackProvisioningParametersResult

class DescribeStackProvisioningParametersResult extends Object implements Serializable

Serialized Fields

agentInstallerUrl

String agentInstallerUrl

The AWS OpsWorks agent installer's URL.

parameters

com.amazonaws.internal.SdkInternalMap<String,String> parameters

An embedded object that contains the provisioning parameters.

Class com.amazonaws.services.opsworks.model.DescribeStacksRequest

class DescribeStacksRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackIds

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeStacksResult extends Object implements Serializable

Serialized Fields

stacks

com.amazonaws.internal.SdkInternalList<Stack> stacks

An array of Stack objects that describe the stacks.

Class com.amazonaws.services.opsworks.model.DescribeStackSummaryRequest

class DescribeStackSummaryRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.DescribeStackSummaryResult

class DescribeStackSummaryResult extends Object implements Serializable

Serialized Fields

stackSummary

StackSummary stackSummary

A StackSummary object that contains the results.

Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingRequest

class DescribeTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceIds

com.amazonaws.internal.SdkInternalList<String> instanceIds

An array of instance IDs.

Class com.amazonaws.services.opsworks.model.DescribeTimeBasedAutoScalingResult

class DescribeTimeBasedAutoScalingResult extends Object implements Serializable

Serialized Fields

timeBasedAutoScalingConfigurations

com.amazonaws.internal.SdkInternalList<TimeBasedAutoScalingConfiguration> timeBasedAutoScalingConfigurations

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

Class com.amazonaws.services.opsworks.model.DescribeUserProfilesRequest

class DescribeUserProfilesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iamUserArns

com.amazonaws.internal.SdkInternalList<String> iamUserArns

An array of IAM user ARNs that identify the users to be described.

Class com.amazonaws.services.opsworks.model.DescribeUserProfilesResult

class DescribeUserProfilesResult extends Object implements Serializable

Serialized Fields

userProfiles

com.amazonaws.internal.SdkInternalList<UserProfile> userProfiles

A Users object that describes the specified users.

Class com.amazonaws.services.opsworks.model.DescribeVolumesRequest

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

raidArrayId

String raidArrayId

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

stackId

String stackId

A stack ID. The action describes the stack's registered Amazon EBS volumes.

volumeIds

com.amazonaws.internal.SdkInternalList<String> 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

class DescribeVolumesResult extends Object implements Serializable

Serialized Fields

volumes

com.amazonaws.internal.SdkInternalList<Volume> volumes

An array of volume IDs.

Class com.amazonaws.services.opsworks.model.DetachElasticLoadBalancerRequest

class 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.DetachElasticLoadBalancerResult

class DetachElasticLoadBalancerResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.DisassociateElasticIpRequest

class DisassociateElasticIpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

elasticIp

String elasticIp

The Elastic IP address.

Class com.amazonaws.services.opsworks.model.DisassociateElasticIpResult

class DisassociateElasticIpResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.EbsBlockDevice

class EbsBlockDevice extends Object implements Serializable

Serialized Fields

deleteOnTermination

Boolean deleteOnTermination

Whether the volume is deleted on instance termination.

iops

Integer iops

The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

snapshotId

String snapshotId

The snapshot ID.

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.

Class com.amazonaws.services.opsworks.model.EcsCluster

class EcsCluster extends Object implements Serializable

Serialized Fields

ecsClusterArn

String ecsClusterArn

The cluster's ARN.

ecsClusterName

String ecsClusterName

The cluster name.

registeredAt

String registeredAt

The time and date that the cluster was registered with the stack.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.ElasticIp

class ElasticIp extends Object implements Serializable

Serialized Fields

domain

String domain

The domain.

instanceId

String instanceId

The ID of the instance that the address is attached to.

ip

String ip

The IP address.

name

String name

The name.

region

String region

The AWS region. For more information, see Regions and Endpoints.

Class com.amazonaws.services.opsworks.model.ElasticLoadBalancer

class ElasticLoadBalancer extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

A list of Availability Zones.

dnsName

String dnsName

The instance's public DNS name.

ec2InstanceIds

com.amazonaws.internal.SdkInternalList<String> ec2InstanceIds

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

elasticLoadBalancerName

String elasticLoadBalancerName

The Elastic Load Balancing instance's name.

layerId

String layerId

The ID of the layer that the instance is attached to.

region

String region

The instance's AWS region.

stackId

String stackId

The ID of the stack that the instance is associated with.

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

A list of subnet IDs, if the stack is running in a VPC.

vpcId

String vpcId

The VPC ID.

Class com.amazonaws.services.opsworks.model.EnvironmentVariable

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

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.

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.

Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionRequest

class GetHostnameSuggestionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

layerId

String layerId

The layer ID.

Class com.amazonaws.services.opsworks.model.GetHostnameSuggestionResult

class GetHostnameSuggestionResult extends Object implements Serializable

Serialized Fields

hostname

String hostname

The generated host name.

layerId

String layerId

The layer ID.

Class com.amazonaws.services.opsworks.model.GrantAccessRequest

class 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

class 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

class 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<BlockDeviceMapping> 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<String> 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<String> 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.

tenancy

String tenancy

The instance's tenancy option, such as dedicated or host.

virtualizationType

String virtualizationType

The instance's virtualization type: paravirtual or hvm.

Class com.amazonaws.services.opsworks.model.InstanceIdentity

class 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

class 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

class Layer extends Object implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.SdkInternalMap<String,String> 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.

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.

createdAt

String createdAt

Date when the layer was created.

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.

customRecipes

Recipes customRecipes

A LayerCustomRecipes object that specifies the layer's custom recipes.

customSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> customSecurityGroupIds

An array containing the layer's custom security group IDs.

defaultRecipes

Recipes defaultRecipes

defaultSecurityGroupNames

com.amazonaws.internal.SdkInternalList<String> defaultSecurityGroupNames

An array containing the layer's security group names.

enableAutoHealing

Boolean enableAutoHealing

Whether auto healing is disabled for the layer.

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.

layerId

String layerId

The layer ID.

lifecycleEventConfiguration

LifecycleEventConfiguration lifecycleEventConfiguration

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

name

String name

The layer name.

packages

com.amazonaws.internal.SdkInternalList<String> packages

An array of Package objects that describe the layer's packages.

shortname

String shortname

The layer short name.

stackId

String stackId

The layer stack ID.

type

String type

The layer type.

useEbsOptimizedInstances

Boolean useEbsOptimizedInstances

Whether the layer uses Amazon EBS-optimized instances.

volumeConfigurations

com.amazonaws.internal.SdkInternalList<VolumeConfiguration> volumeConfigurations

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Class com.amazonaws.services.opsworks.model.LifecycleEventConfiguration

class 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

class LoadBasedAutoScalingConfiguration extends Object implements Serializable

Serialized Fields

downScaling

AutoScalingThresholds downScaling

An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks reduces the number of instances.

enable

Boolean enable

Whether load-based auto scaling is enabled for the layer.

layerId

String layerId

The layer ID.

upScaling

AutoScalingThresholds upScaling

An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks increases the number of instances.

Class com.amazonaws.services.opsworks.model.Permission

class Permission extends Object implements Serializable

Serialized Fields

allowSsh

Boolean allowSsh

Whether the user can use SSH.

allowSudo

Boolean allowSudo

Whether the user can use sudo.

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.

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

stackId

String stackId

A stack ID.

Class com.amazonaws.services.opsworks.model.RaidArray

class RaidArray extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The array's Availability Zone. For more information, see Regions and Endpoints.

createdAt

String createdAt

When the RAID array was created.

device

String device

The array's Linux device. For example /dev/mdadm0.

instanceId

String instanceId

The instance ID.

iops

Integer iops

For PIOPS volumes, the IOPS per disk.

mountPoint

String mountPoint

The array's mount point.

name

String name

The array name.

numberOfDisks

Integer numberOfDisks

The number of disks in the array.

raidArrayId

String raidArrayId

The array ID.

raidLevel

Integer raidLevel

The RAID level.

size

Integer size

The array's size.

stackId

String stackId

The stack ID.

volumeType

String volumeType

The volume type, standard or PIOPS.

Class com.amazonaws.services.opsworks.model.RdsDbInstance

class RdsDbInstance extends Object implements Serializable

Serialized Fields

address

String address

The instance's address.

dbInstanceIdentifier

String dbInstanceIdentifier

The DB instance identifier.

dbPassword

String dbPassword

AWS OpsWorks returns *****FILTERED***** instead of the actual value.

dbUser

String dbUser

The master user name.

engine

String engine

The instance's database engine.

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.

rdsDbInstanceArn

String rdsDbInstanceArn

The instance's ARN.

region

String region

The instance's AWS region.

stackId

String stackId

The ID of the stack that the instance is registered with.

Class com.amazonaws.services.opsworks.model.RebootInstanceRequest

class RebootInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.RebootInstanceResult

class RebootInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.Recipes

class Recipes extends Object implements Serializable

Serialized Fields

configure

com.amazonaws.internal.SdkInternalList<String> configure

An array of custom recipe names to be run following a configure event.

deploy

com.amazonaws.internal.SdkInternalList<String> deploy

An array of custom recipe names to be run following a deploy event.

setup

com.amazonaws.internal.SdkInternalList<String> setup

An array of custom recipe names to be run following a setup event.

shutdown

com.amazonaws.internal.SdkInternalList<String> shutdown

An array of custom recipe names to be run following a shutdown event.

undeploy

com.amazonaws.internal.SdkInternalList<String> undeploy

An array of custom recipe names to be run following a undeploy event.

Class com.amazonaws.services.opsworks.model.RegisterEcsClusterRequest

class 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

class RegisterEcsClusterResult extends Object implements Serializable

Serialized Fields

ecsClusterArn

String ecsClusterArn

The cluster's ARN.

Class com.amazonaws.services.opsworks.model.RegisterElasticIpRequest

class 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

class RegisterElasticIpResult extends Object implements Serializable

Serialized Fields

elasticIp

String elasticIp

The Elastic IP address.

Class com.amazonaws.services.opsworks.model.RegisterInstanceRequest

class RegisterInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

hostname

String hostname

The instance's hostname.

instanceIdentity

InstanceIdentity instanceIdentity

An InstanceIdentity object that contains the instance's identity.

privateIp

String privateIp

The instance's private IP address.

publicIp

String publicIp

The instance's public 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.

stackId

String stackId

The ID of the stack that the instance is to be registered with.

Class com.amazonaws.services.opsworks.model.RegisterInstanceResult

class RegisterInstanceResult extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The registered instance's AWS OpsWorks ID.

Class com.amazonaws.services.opsworks.model.RegisterRdsDbInstanceRequest

class RegisterRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dbPassword

String dbPassword

The database password.

dbUser

String dbUser

The database's master user name.

rdsDbInstanceArn

String rdsDbInstanceArn

The Amazon RDS instance's ARN.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.RegisterRdsDbInstanceResult

class RegisterRdsDbInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.RegisterVolumeRequest

class 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

class RegisterVolumeResult extends Object implements Serializable

Serialized Fields

volumeId

String volumeId

The volume ID.

Class com.amazonaws.services.opsworks.model.ReportedOs

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

Exception Class com.amazonaws.services.opsworks.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.opsworks.model.SelfUserProfile

class SelfUserProfile extends Object implements Serializable

Serialized Fields

iamUserArn

String iamUserArn

The user's IAM ARN.

name

String name

The user's name.

sshPublicKey

String sshPublicKey

The user's SSH public key.

sshUsername

String sshUsername

The user's SSH user name.

Class com.amazonaws.services.opsworks.model.ServiceError

class ServiceError extends Object implements Serializable

Serialized Fields

createdAt

String createdAt

When the error occurred.

instanceId

String instanceId

The instance ID.

message

String message

A message that describes the error.

serviceErrorId

String serviceErrorId

The error ID.

stackId

String stackId

The stack ID.

type

String type

The error type.

Class com.amazonaws.services.opsworks.model.SetLoadBasedAutoScalingRequest

class SetLoadBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

enable

Boolean enable

Enables load-based auto scaling for the layer.

layerId

String layerId

The layer ID.

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.

Class com.amazonaws.services.opsworks.model.SetLoadBasedAutoScalingResult

class SetLoadBasedAutoScalingResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.SetPermissionRequest

class SetPermissionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

iamUserArn

String iamUserArn

The user's IAM ARN.

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.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.SetPermissionResult

class SetPermissionResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.SetTimeBasedAutoScalingRequest

class SetTimeBasedAutoScalingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

autoScalingSchedule

WeeklyAutoScalingSchedule autoScalingSchedule

An AutoScalingSchedule with the instance schedule.

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.SetTimeBasedAutoScalingResult

class SetTimeBasedAutoScalingResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.ShutdownEventConfiguration

class ShutdownEventConfiguration extends Object implements Serializable

Serialized Fields

delayUntilElbConnectionsDrained

Boolean delayUntilElbConnectionsDrained

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

executionTimeout

Integer executionTimeout

The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.

Class com.amazonaws.services.opsworks.model.Source

class Source extends Object implements Serializable

Serialized Fields

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.

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.

sshKey

String sshKey

In requests, the repository's SSH key.

In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.

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.

Class com.amazonaws.services.opsworks.model.SslConfiguration

class SslConfiguration extends Object implements Serializable

Serialized Fields

certificate

String certificate

The contents of the certificate's domain.crt file.

chain

String chain

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

privateKey

String privateKey

The private key; the contents of the certificate's domain.kex file.

Class com.amazonaws.services.opsworks.model.Stack

class Stack extends Object implements Serializable

Serialized Fields

agentVersion

String agentVersion

The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

arn

String arn

The stack's ARN.

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

The stack's attributes.

chefConfiguration

ChefConfiguration chefConfiguration

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

configurationManager

StackConfigurationManager configurationManager

The configuration manager.

createdAt

String createdAt

The date when the stack was created.

customCookbooksSource

Source customCookbooksSource

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.

defaultAvailabilityZone

String defaultAvailabilityZone

The stack's default Availability Zone. For more information, see Regions and Endpoints.

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.

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.

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.

defaultSubnetId

String defaultSubnetId

The default subnet ID; applicable only if the stack is running in a VPC.

hostnameTheme

String hostnameTheme

The stack host name theme, with spaces replaced by underscores.

name

String name

The stack name.

region

String region

The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.

serviceRoleArn

String serviceRoleArn

The stack AWS Identity and Access Management (IAM) role.

stackId

String stackId

The stack ID.

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.

vpcId

String vpcId

The VPC ID; applicable only if the stack is running in a VPC.

Class com.amazonaws.services.opsworks.model.StackConfigurationManager

class 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

class StackSummary extends Object implements Serializable

Serialized Fields

appsCount

Integer appsCount

The number of apps.

arn

String arn

The stack's ARN.

instancesCount

InstancesCount instancesCount

An InstancesCount object with the number of instances in each status.

layersCount

Integer layersCount

The number of layers.

name

String name

The stack name.

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.StartInstanceRequest

class StartInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.StartInstanceResult

class StartInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.StartStackRequest

class StartStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.StartStackResult

class StartStackResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.StopInstanceRequest

class StopInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.StopInstanceResult

class StopInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.StopStackRequest

class StopStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

stackId

String stackId

The stack ID.

Class com.amazonaws.services.opsworks.model.StopStackResult

class StopStackResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.TemporaryCredential

class TemporaryCredential extends Object implements Serializable

Serialized Fields

instanceId

String instanceId

The instance's AWS OpsWorks ID.

password

String password

The password.

username

String username

The user name.

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.

Class com.amazonaws.services.opsworks.model.TimeBasedAutoScalingConfiguration

class TimeBasedAutoScalingConfiguration extends Object implements Serializable

Serialized Fields

autoScalingSchedule

WeeklyAutoScalingSchedule autoScalingSchedule

A WeeklyAutoScalingSchedule object with the instance schedule.

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.UnassignInstanceRequest

class UnassignInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

instanceId

String instanceId

The instance ID.

Class com.amazonaws.services.opsworks.model.UnassignInstanceResult

class UnassignInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UnassignVolumeRequest

class UnassignVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

volumeId

String volumeId

The volume ID.

Class com.amazonaws.services.opsworks.model.UnassignVolumeResult

class UnassignVolumeResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateAppRequest

class UpdateAppRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

appId

String appId

The app ID.

appSource

Source appSource

A Source object that specifies the app repository.

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

One or more user-defined key/value pairs to be added to the stack attributes.

dataSources

com.amazonaws.internal.SdkInternalList<DataSource> dataSources

The app's data sources.

description

String description

A description of the app.

domains

com.amazonaws.internal.SdkInternalList<String> 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.

environment

com.amazonaws.internal.SdkInternalList<EnvironmentVariable> 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.

name

String name

The app name.

sslConfiguration

SslConfiguration sslConfiguration

An SslConfiguration object with the SSL configuration.

type

String type

The app type.

Class com.amazonaws.services.opsworks.model.UpdateAppResult

class UpdateAppResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateElasticIpRequest

class UpdateElasticIpRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

elasticIp

String elasticIp

The address.

name

String name

The new name.

Class com.amazonaws.services.opsworks.model.UpdateElasticIpResult

class UpdateElasticIpResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateInstanceRequest

class UpdateInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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.

autoScalingType

String autoScalingType

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

ebsOptimized

Boolean ebsOptimized

This property cannot be updated.

hostname

String hostname

The instance host name.

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.

instanceId

String instanceId

The instance ID.

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.

layerIds

com.amazonaws.internal.SdkInternalList<String> layerIds

The instance's layer IDs.

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.

sshKeyName

String sshKeyName

The instance's Amazon EC2 key name.

Class com.amazonaws.services.opsworks.model.UpdateInstanceResult

class UpdateInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateLayerRequest

class UpdateLayerRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

One or more user-defined key/value pairs to be added to the stack attributes.

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.

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.

customRecipes

Recipes customRecipes

A LayerCustomRecipes object that specifies the layer's custom recipes.

customSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> customSecurityGroupIds

An array containing the layer's custom security group IDs.

enableAutoHealing

Boolean enableAutoHealing

Whether to disable auto healing for the layer.

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.

layerId

String layerId

The layer ID.

lifecycleEventConfiguration

LifecycleEventConfiguration lifecycleEventConfiguration

name

String name

The layer name, which is used by the console.

packages

com.amazonaws.internal.SdkInternalList<String> packages

An array of Package objects that describe the layer's packages.

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

useEbsOptimizedInstances

Boolean useEbsOptimizedInstances

Whether to use Amazon EBS-optimized instances.

volumeConfigurations

com.amazonaws.internal.SdkInternalList<VolumeConfiguration> volumeConfigurations

A VolumeConfigurations object that describes the layer's Amazon EBS volumes.

Class com.amazonaws.services.opsworks.model.UpdateLayerResult

class UpdateLayerResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateMyUserProfileRequest

class UpdateMyUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sshPublicKey

String sshPublicKey

The user's SSH public key.

Class com.amazonaws.services.opsworks.model.UpdateMyUserProfileResult

class UpdateMyUserProfileResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateRdsDbInstanceRequest

class UpdateRdsDbInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dbPassword

String dbPassword

The database password.

dbUser

String dbUser

The master user name.

rdsDbInstanceArn

String rdsDbInstanceArn

The Amazon RDS instance's ARN.

Class com.amazonaws.services.opsworks.model.UpdateRdsDbInstanceResult

class UpdateRdsDbInstanceResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateStackRequest

class UpdateStackRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

attributes

com.amazonaws.internal.SdkInternalMap<String,String> attributes

One or more user-defined key-value pairs to be added to the stack attributes.

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.

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.

customCookbooksSource

Source customCookbooksSource

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.

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.

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.

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.

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.

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.

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.

name

String name

The stack's new name.

serviceRoleArn

String serviceRoleArn

Do not use this parameter. You cannot update a stack's service role.

stackId

String stackId

The stack ID.

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

Class com.amazonaws.services.opsworks.model.UpdateStackResult

class UpdateStackResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateUserProfileRequest

class UpdateUserProfileRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

allowSelfManagement

Boolean allowSelfManagement

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

iamUserArn

String iamUserArn

The user IAM ARN.

sshPublicKey

String sshPublicKey

The user's new SSH public key.

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.

Class com.amazonaws.services.opsworks.model.UpdateUserProfileResult

class UpdateUserProfileResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UpdateVolumeRequest

class UpdateVolumeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

mountPoint

String mountPoint

The new mount point.

name

String name

The new name.

volumeId

String volumeId

The volume ID.

Class com.amazonaws.services.opsworks.model.UpdateVolumeResult

class UpdateVolumeResult extends Object implements Serializable

Class com.amazonaws.services.opsworks.model.UserProfile

class UserProfile extends Object implements Serializable

Serialized Fields

allowSelfManagement

Boolean allowSelfManagement

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

iamUserArn

String iamUserArn

The user's IAM ARN.

name

String name

The user's name.

sshPublicKey

String sshPublicKey

The user's SSH public key.

sshUsername

String sshUsername

The user's SSH user name.

Exception Class com.amazonaws.services.opsworks.model.ValidationException

class ValidationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.opsworks.model.Volume

class Volume extends Object implements Serializable

Serialized Fields

availabilityZone

String availabilityZone

The volume Availability Zone. For more information, see Regions and Endpoints.

device

String device

The device name.

ec2VolumeId

String ec2VolumeId

The Amazon EC2 volume ID.

instanceId

String instanceId

The instance ID.

iops

Integer iops

For PIOPS volumes, the IOPS per disk.

mountPoint

String mountPoint

The volume mount point. For example, "/mnt/disk1".

name

String name

The volume name.

raidArrayId

String raidArrayId

The RAID array ID.

region

String region

The AWS region. For more information about AWS regions, see Regions and Endpoints.

size

Integer size

The volume size.

status

String status

The value returned by DescribeVolumes.

volumeId

String volumeId

The volume ID.

volumeType

String volumeType

The volume type, standard or PIOPS.

Class com.amazonaws.services.opsworks.model.VolumeConfiguration

class VolumeConfiguration extends Object implements Serializable

Serialized Fields

iops

Integer iops

For PIOPS volumes, the IOPS per disk.

mountPoint

String mountPoint

The volume mount point. For example "/dev/sdh".

numberOfDisks

Integer numberOfDisks

The number of disks in the volume.

raidLevel

Integer raidLevel

The volume RAID level.

size

Integer size

The volume size.

volumeType

String volumeType

The volume type:

• standard - Magnetic
• io1 - Provisioned IOPS (SSD)
• gp2 - General Purpose (SSD)

Class com.amazonaws.services.opsworks.model.WeeklyAutoScalingSchedule

class WeeklyAutoScalingSchedule extends Object implements Serializable

Serialized Fields

friday

com.amazonaws.internal.SdkInternalMap<String,String> friday

The schedule for Friday.

monday

com.amazonaws.internal.SdkInternalMap<String,String> monday

The schedule for Monday.

saturday

com.amazonaws.internal.SdkInternalMap<String,String> saturday

The schedule for Saturday.

sunday

com.amazonaws.internal.SdkInternalMap<String,String> sunday

The schedule for Sunday.

thursday

com.amazonaws.internal.SdkInternalMap<String,String> thursday

The schedule for Thursday.

tuesday

com.amazonaws.internal.SdkInternalMap<String,String> tuesday

The schedule for Tuesday.

wednesday

com.amazonaws.internal.SdkInternalMap<String,String> wednesday

The schedule for Wednesday.

Package com.amazonaws.services.rds.model

Class com.amazonaws.services.rds.model.AccountQuota

class AccountQuota extends Object implements Serializable

Serialized Fields

accountQuotaName

String accountQuotaName

The name of the Amazon RDS quota for this AWS account.

max

Long max

The maximum allowed value for the quota.

used

Long used

The amount currently used toward the quota maximum.

Class com.amazonaws.services.rds.model.AddSourceIdentifierToSubscriptionRequest

class AddSourceIdentifierToSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

subscriptionName

String subscriptionName

The name of the RDS event notification subscription you want to add a source identifier to.

Class com.amazonaws.services.rds.model.AddTagsToResourceRequest

class 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.SdkInternalList<Tag> tags

The tags to be assigned to the Amazon RDS resource.

Class com.amazonaws.services.rds.model.AddTagsToResourceResult

class AddTagsToResourceResult extends Object implements Serializable

Class com.amazonaws.services.rds.model.ApplyPendingMaintenanceActionRequest

class ApplyPendingMaintenanceActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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

Exception Class com.amazonaws.services.rds.model.AuthorizationAlreadyExistsException

class AuthorizationAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.AuthorizationNotFoundException

class AuthorizationNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.AuthorizationQuotaExceededException

class AuthorizationQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.AuthorizeDBSecurityGroupIngressRequest

class AuthorizeDBSecurityGroupIngressRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

cIDRIP

String cIDRIP

The IP range to authorize.

dBSecurityGroupName

String dBSecurityGroupName

The name of the DB security group to add authorization to.

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.

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.

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

class AvailabilityZone extends Object implements Serializable

Serialized Fields

name

String name

The name of the availability zone.

Class com.amazonaws.services.rds.model.Certificate

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

Exception Class com.amazonaws.services.rds.model.CertificateNotFoundException

class CertificateNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.CharacterSet

class CharacterSet extends Object implements Serializable

Serialized Fields

characterSetDescription

String characterSetDescription

The description of the character set.

characterSetName

String characterSetName

The name of the character set.

Class com.amazonaws.services.rds.model.CopyDBClusterSnapshotRequest

class 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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

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

Class com.amazonaws.services.rds.model.CopyDBParameterGroupRequest

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

targetDBParameterGroupDescription

String targetDBParameterGroupDescription

A description for the copied DB parameter group.

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

Class com.amazonaws.services.rds.model.CopyDBSnapshotRequest

class CopyDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

copyTags

Boolean copyTags

True to copy all tags from the source DB snapshot to the target DB snapshot; otherwise false. The default is false.

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.

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

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

Class com.amazonaws.services.rds.model.CopyOptionGroupRequest

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

targetOptionGroupDescription

String targetOptionGroupDescription

The description for the copied option group.

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

Class com.amazonaws.services.rds.model.CreateDBClusterParameterGroupRequest

class 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.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.CreateDBClusterRequest

class CreateDBClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> 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

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

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.

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.

port

Integer port

The port number on which the instances in the DB cluster accept connections.

Default: 3306

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.

storageEncrypted

Boolean storageEncrypted

Specifies whether the DB cluster is encrypted.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

vpcSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupIds

A list of EC2 VPC security groups to associate with this DB cluster.

Class com.amazonaws.services.rds.model.CreateDBClusterSnapshotRequest

class CreateDBClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

The tags to be assigned to the DB cluster snapshot.

Class com.amazonaws.services.rds.model.CreateDBInstanceReadReplicaRequest

class CreateDBInstanceReadReplicaRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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

copyTagsToSnapshot

Boolean copyTagsToSnapshot

True to copy all tags from the Read Replica to snapshots of the Read Replica; otherwise false. The default is false.

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.

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.

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

iops

Integer iops

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

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.

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.

port

Integer port

The port number that the DB instance uses for connections.

Default: Inherits from the source DB instance

Valid Values: 1150-65535

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.

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

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.CreateDBInstanceRequest

class CreateDBInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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)

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.

Default: true

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.

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

characterSetName

String characterSetName

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

copyTagsToSnapshot

Boolean copyTagsToSnapshot

True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

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

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

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

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

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

dBSecurityGroups

com.amazonaws.internal.SdkInternalList<String> dBSecurityGroups

A list of DB security groups to associate with this DB instance.

Default: The default DB security group for the database engine.

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.

domain

String domain

Specify the Active Directory Domain to create the instance in.

domainIAMRoleName

String domainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

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.

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

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.

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.

licenseModel

String licenseModel

License model information for this DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

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.

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.

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.

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

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

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.

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.

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

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.

storageEncrypted

Boolean storageEncrypted

Specifies whether the DB instance is encrypted.

Default: false

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

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.

vpcSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> 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.

Class com.amazonaws.services.rds.model.CreateDBParameterGroupRequest

class CreateDBParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

description

String description

The description for the DB parameter group.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.CreateDBSecurityGroupRequest

class CreateDBSecurityGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSecurityGroupDescription

String dBSecurityGroupDescription

The description for the DB security group.

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.CreateDBSnapshotRequest

class CreateDBSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.CreateDBSubnetGroupRequest

class CreateDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSubnetGroupDescription

String dBSubnetGroupDescription

The description for the DB subnet group.

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

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

The EC2 Subnet IDs for the DB subnet group.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.CreateEventSubscriptionRequest

class CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

enabled

Boolean enabled

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

eventCategories

com.amazonaws.internal.SdkInternalList<String> 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.

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.

sourceIds

com.amazonaws.internal.SdkInternalList<String> 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.

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

subscriptionName

String subscriptionName

The name of the subscription.

Constraints: The name must be less than 255 characters.

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.CreateOptionGroupRequest

class CreateOptionGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.DBCluster

class DBCluster extends Object implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

Specifies the allocated storage size in gigabytes (GB).

availabilityZones

com.amazonaws.internal.SdkInternalList<String> 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.

dBClusterMembers

com.amazonaws.internal.SdkInternalList<DBClusterMember> dBClusterMembers

Provides the list of instances that make up the DB cluster.

dBClusterOptionGroupMemberships

com.amazonaws.internal.SdkInternalList<DBClusterOptionGroupStatus> dBClusterOptionGroupMemberships

Provides the list of option group memberships for this DB cluster.

dBClusterParameterGroup

String dBClusterParameterGroup

Specifies the name of the DB cluster parameter group for the 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.

dBSubnetGroup

String dBSubnetGroup

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

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.

hostedZoneId

String hostedZoneId

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

kmsKeyId

String kmsKeyId

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

latestRestorableTime

Date latestRestorableTime

Specifies the latest time to which a database can be restored with point-in-time restore.

masterUsername

String masterUsername

Contains the master username for the DB cluster.

percentProgress

String percentProgress

Specifies the progress of the operation as a percentage.

port

Integer port

Specifies the port that the database engine is listening on.

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

status

String status

Specifies the current state of this DB cluster.

storageEncrypted

Boolean storageEncrypted

Specifies whether the DB cluster is encrypted.

vpcSecurityGroups

com.amazonaws.internal.SdkInternalList<VpcSecurityGroupMembership> vpcSecurityGroups

Provides a list of VPC security groups that the DB cluster belongs to.

Exception Class com.amazonaws.services.rds.model.DBClusterAlreadyExistsException

class DBClusterAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBClusterMember

class DBClusterMember extends Object implements Serializable

Serialized Fields

dBClusterParameterGroupStatus

String dBClusterParameterGroupStatus

Specifies the status of the DB cluster parameter group for this member of the DB cluster.

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.

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.

Exception Class com.amazonaws.services.rds.model.DBClusterNotFoundException

class DBClusterNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBClusterOptionGroupStatus

class 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

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

Exception Class com.amazonaws.services.rds.model.DBClusterParameterGroupNotFoundException

class DBClusterParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBClusterQuotaExceededException

class DBClusterQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBClusterSnapshot

class DBClusterSnapshot extends Object implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

Specifies the allocated storage size in gigabytes (GB).

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

clusterCreateTime

Date clusterCreateTime

Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

dBClusterIdentifier

String dBClusterIdentifier

Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

dBClusterSnapshotIdentifier

String dBClusterSnapshotIdentifier

Specifies the identifier for the DB cluster snapshot.

engine

String engine

Specifies the name of the database engine.

engineVersion

String engineVersion

Provides the version of the database engine for this DB cluster snapshot.

kmsKeyId

String kmsKeyId

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster snapshot.

licenseModel

String licenseModel

Provides the license model information for this DB cluster snapshot.

masterUsername

String masterUsername

Provides the master username for the DB cluster snapshot.

percentProgress

Integer percentProgress

Specifies the percentage of the estimated data that has been transferred.

port

Integer port

Specifies the port that the DB cluster was listening on at the time of the snapshot.

snapshotCreateTime

Date snapshotCreateTime

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

snapshotType

String snapshotType

Provides the type of the DB cluster snapshot.

status

String status

Specifies the status of this DB cluster snapshot.

storageEncrypted

Boolean storageEncrypted

Specifies whether the DB cluster snapshot is encrypted.

vpcId

String vpcId

Provides the VPC ID associated with the DB cluster snapshot.

Exception Class com.amazonaws.services.rds.model.DBClusterSnapshotAlreadyExistsException

class DBClusterSnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBClusterSnapshotNotFoundException

class DBClusterSnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBEngineVersion

class DBEngineVersion extends Object implements Serializable

Serialized Fields

dBEngineDescription

String dBEngineDescription

The description of the database engine.

dBEngineVersionDescription

String dBEngineVersionDescription

The description of the database engine version.

dBParameterGroupFamily

String dBParameterGroupFamily

The name of the DB parameter group family for the database engine.

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.

engine

String engine

The name of the database engine.

engineVersion

String engineVersion

The version number of the database engine.

supportedCharacterSets

com.amazonaws.internal.SdkInternalList<CharacterSet> supportedCharacterSets

A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance API.

validUpgradeTarget

com.amazonaws.internal.SdkInternalList<UpgradeTarget> validUpgradeTarget

A list of engine versions that this database engine version can be upgraded to.

Class com.amazonaws.services.rds.model.DBInstance

class DBInstance extends Object implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

Specifies the allocated storage size specified in gigabytes.

autoMinorVersionUpgrade

Boolean autoMinorVersionUpgrade

Indicates that minor version patches are applied automatically.

availabilityZone

String availabilityZone

Specifies the name of the Availability Zone the DB instance is located in.

backupRetentionPeriod

Integer backupRetentionPeriod

Specifies the number of days for which automatic DB snapshots are retained.

cACertificateIdentifier

String cACertificateIdentifier

The identifier of the CA certificate for this DB instance.

characterSetName

String characterSetName

If present, specifies the name of the character set that this instance is associated with.

copyTagsToSnapshot

Boolean copyTagsToSnapshot

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

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.

dBInstanceClass

String dBInstanceClass

Contains the name of the compute and memory capacity class of the DB instance.

dBInstanceIdentifier

String dBInstanceIdentifier

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

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.

dBInstanceStatus

String dBInstanceStatus

Specifies the current state of this database.

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.

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.

dBParameterGroups

com.amazonaws.internal.SdkInternalList<DBParameterGroupStatus> dBParameterGroups

Provides the list of DB parameter groups applied to this DB instance.

dBSecurityGroups

com.amazonaws.internal.SdkInternalList<DBSecurityGroupMembership> dBSecurityGroups

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

dBSubnetGroup

DBSubnetGroup dBSubnetGroup

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

domainMemberships

com.amazonaws.internal.SdkInternalList<DomainMembership> domainMemberships

The Active Directory Domain membership records associated with the DB instance.

endpoint

Endpoint endpoint

Specifies the connection endpoint.

engine

String engine

Provides the name of the database engine to be used for this DB instance.

engineVersion

String engineVersion

Indicates the database engine version.

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.

instanceCreateTime

Date instanceCreateTime

Provides the date and time the DB instance was created.

iops

Integer iops

Specifies the Provisioned IOPS (I/O operations per second) value.

kmsKeyId

String kmsKeyId

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.

latestRestorableTime

Date latestRestorableTime

Specifies the latest time to which a database can be restored with point-in-time restore.

licenseModel

String licenseModel

License model information for this DB instance.

masterUsername

String masterUsername

Contains the master username for the DB instance.

monitoringInterval

Integer monitoringInterval

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

monitoringRoleArn

String monitoringRoleArn

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to CloudWatch Logs.

multiAZ

Boolean multiAZ

Specifies if the DB instance is a Multi-AZ deployment.

optionGroupMemberships

com.amazonaws.internal.SdkInternalList<OptionGroupMembership> optionGroupMemberships

Provides the list of option group memberships for this DB instance.

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.

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

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.

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.

readReplicaDBInstanceIdentifiers

com.amazonaws.internal.SdkInternalList<String> readReplicaDBInstanceIdentifiers

Contains one or more identifiers of the Read Replicas associated with this DB instance.

readReplicaSourceDBInstanceIdentifier

String readReplicaSourceDBInstanceIdentifier

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

secondaryAvailabilityZone

String secondaryAvailabilityZone

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

statusInfos

com.amazonaws.internal.SdkInternalList<DBInstanceStatusInfo> statusInfos

The status of a Read Replica. If the instance is not a Read Replica, this will be blank.

storageEncrypted

Boolean storageEncrypted

Specifies whether the DB instance is encrypted.

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.

vpcSecurityGroups

com.amazonaws.internal.SdkInternalList<VpcSecurityGroupMembership> vpcSecurityGroups

Provides List of VPC security group elements that the DB instance belongs to.

Exception Class com.amazonaws.services.rds.model.DBInstanceAlreadyExistsException

class DBInstanceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBInstanceNotFoundException

class DBInstanceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBInstanceStatusInfo

class DBInstanceStatusInfo extends Object implements Serializable

Serialized Fields

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.

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.

statusType

String statusType

This value is currently "read replication."

Exception Class com.amazonaws.services.rds.model.DBLogFileNotFoundException

class DBLogFileNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBParameterGroup

class DBParameterGroup extends Object implements Serializable

Serialized Fields

dBParameterGroupFamily

String dBParameterGroupFamily

Provides the name of the DB parameter group family that this DB parameter group is compatible with.

dBParameterGroupName

String dBParameterGroupName

Provides the name of the DB parameter group.

description

String description

Provides the customer-specified description for this DB parameter group.

Exception Class com.amazonaws.services.rds.model.DBParameterGroupAlreadyExistsException

class DBParameterGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBParameterGroupNotFoundException

class DBParameterGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBParameterGroupQuotaExceededException

class DBParameterGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBParameterGroupStatus

class 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

class DBSecurityGroup extends Object implements Serializable

Serialized Fields

dBSecurityGroupDescription

String dBSecurityGroupDescription

Provides the description of the DB security group.

dBSecurityGroupName

String dBSecurityGroupName

Specifies the name of the DB security group.

eC2SecurityGroups

com.amazonaws.internal.SdkInternalList<EC2SecurityGroup> eC2SecurityGroups

Contains a list of EC2SecurityGroup elements.

iPRanges

com.amazonaws.internal.SdkInternalList<IPRange> iPRanges

Contains a list of IPRange elements.

ownerId

String ownerId

Provides the AWS ID of the owner of a specific DB security group.

vpcId

String vpcId

Provides the VpcId of the DB security group.

Exception Class com.amazonaws.services.rds.model.DBSecurityGroupAlreadyExistsException

class DBSecurityGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBSecurityGroupMembership

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

Exception Class com.amazonaws.services.rds.model.DBSecurityGroupNotFoundException

class DBSecurityGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBSecurityGroupNotSupportedException

class DBSecurityGroupNotSupportedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBSecurityGroupQuotaExceededException

class DBSecurityGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBSnapshot

class DBSnapshot extends Object implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

Specifies the allocated storage size in gigabytes (GB).

availabilityZone

String availabilityZone

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

dBInstanceIdentifier

String dBInstanceIdentifier

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

dBSnapshotIdentifier

String dBSnapshotIdentifier

Specifies the identifier for the DB snapshot.

encrypted

Boolean encrypted

Specifies whether the DB snapshot is encrypted.

engine

String engine

Specifies the name of the database engine.

engineVersion

String engineVersion

Specifies the version of the database engine.

instanceCreateTime

Date instanceCreateTime

Specifies the time when the snapshot was taken, in Universal Coordinated Time (UTC).

iops

Integer iops

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

kmsKeyId

String kmsKeyId

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

licenseModel

String licenseModel

License model information for the restored DB instance.

masterUsername

String masterUsername

Provides the master username for the DB 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.

port

Integer port

Specifies the port that the database engine was listening on at the time of the snapshot.

snapshotCreateTime

Date snapshotCreateTime

Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

snapshotType

String snapshotType

Provides the type of the DB snapshot.

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.

sourceRegion

String sourceRegion

The region that the DB snapshot was created in or copied from.

status

String status

Specifies the status of this DB snapshot.

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.

vpcId

String vpcId

Provides the VPC ID associated with the DB snapshot.

Exception Class com.amazonaws.services.rds.model.DBSnapshotAlreadyExistsException

class DBSnapshotAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBSnapshotAttribute

class 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.SdkInternalList<String> 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

class DBSnapshotAttributesResult extends Object implements Serializable

Serialized Fields

dBSnapshotAttributes

com.amazonaws.internal.SdkInternalList<DBSnapshotAttribute> dBSnapshotAttributes

The list of attributes and values for the manual DB snapshot.

dBSnapshotIdentifier

String dBSnapshotIdentifier

The identifier of the manual DB snapshot that the attributes apply to.

Exception Class com.amazonaws.services.rds.model.DBSnapshotNotFoundException

class DBSnapshotNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DBSubnetGroup

class DBSubnetGroup extends Object implements Serializable

Serialized Fields

dBSubnetGroupDescription

String dBSubnetGroupDescription

Provides the description of the DB subnet group.

dBSubnetGroupName

String dBSubnetGroupName

The name of the DB subnet group.

subnetGroupStatus

String subnetGroupStatus

Provides the status of the DB subnet group.

subnets

com.amazonaws.internal.SdkInternalList<Subnet> subnets

Contains a list of Subnet elements.

vpcId

String vpcId

Provides the VpcId of the DB subnet group.

Exception Class com.amazonaws.services.rds.model.DBSubnetGroupAlreadyExistsException

class DBSubnetGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBSubnetGroupDoesNotCoverEnoughAZsException

class DBSubnetGroupDoesNotCoverEnoughAZsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBSubnetGroupNotAllowedException

class DBSubnetGroupNotAllowedException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBSubnetGroupNotFoundException

class DBSubnetGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBSubnetGroupQuotaExceededException

class DBSubnetGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBSubnetQuotaExceededException

class DBSubnetQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.DBUpgradeDependencyFailureException

class DBUpgradeDependencyFailureException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DeleteDBClusterParameterGroupRequest

class 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.DeleteDBClusterParameterGroupResult

class DeleteDBClusterParameterGroupResult extends Object implements Serializable

Class com.amazonaws.services.rds.model.DeleteDBClusterRequest

class 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

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

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

Class com.amazonaws.services.rds.model.DeleteDBClusterSnapshotRequest

class 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

class 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

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.

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

Class com.amazonaws.services.rds.model.DeleteDBParameterGroupRequest

class 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.DeleteDBParameterGroupResult

class DeleteDBParameterGroupResult extends Object implements Serializable

Class com.amazonaws.services.rds.model.DeleteDBSecurityGroupRequest

class 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.DeleteDBSecurityGroupResult

class DeleteDBSecurityGroupResult extends Object implements Serializable

Class com.amazonaws.services.rds.model.DeleteDBSnapshotRequest

class 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

class 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.DeleteDBSubnetGroupResult

class DeleteDBSubnetGroupResult extends Object implements Serializable

Class com.amazonaws.services.rds.model.DeleteEventSubscriptionRequest

class 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

class 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.DeleteOptionGroupResult

class DeleteOptionGroupResult extends Object implements Serializable

Class com.amazonaws.services.rds.model.DescribeAccountAttributesRequest

class DescribeAccountAttributesRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.rds.model.DescribeAccountAttributesResult

class DescribeAccountAttributesResult extends Object implements Serializable

Serialized Fields

accountQuotas

com.amazonaws.internal.SdkInternalList<AccountQuota> 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

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeCertificatesResult extends Object implements Serializable

Serialized Fields

certificates

com.amazonaws.internal.SdkInternalList<Certificate> 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

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeDBClusterParameterGroupsResult extends Object implements Serializable

Serialized Fields

dBClusterParameterGroups

com.amazonaws.internal.SdkInternalList<DBClusterParameterGroup> dBClusterParameterGroups

A list of DB cluster parameter groups.

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

class 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

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

source

String source

A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

Class com.amazonaws.services.rds.model.DescribeDBClusterParametersResult

class DescribeDBClusterParametersResult extends Object implements Serializable

Serialized Fields

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 .

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

Provides a list of parameters for the DB cluster parameter group.

Class com.amazonaws.services.rds.model.DescribeDBClusterSnapshotsRequest

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

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

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.

Class com.amazonaws.services.rds.model.DescribeDBClusterSnapshotsResult

class DescribeDBClusterSnapshotsResult extends Object implements Serializable

Serialized Fields

dBClusterSnapshots

com.amazonaws.internal.SdkInternalList<DBClusterSnapshot> dBClusterSnapshots

Provides a list of DB cluster snapshots for the user.

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

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeDBClustersResult extends Object implements Serializable

Serialized Fields

dBClusters

com.amazonaws.internal.SdkInternalList<DBCluster> dBClusters

Contains a list of DB clusters for the user.

marker

String marker

A pagination token that can be used in a subsequent DescribeDBClusters request.

Class com.amazonaws.services.rds.model.DescribeDBEngineVersionsRequest

class DescribeDBEngineVersionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

defaultOnly

Boolean defaultOnly

Indicates that only the default version of the specified engine or engine and major version combination is returned.

engine

String engine

The database engine to return.

engineVersion

String engineVersion

The database engine version to return.

Example: 5.1.49

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

Not currently supported.

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.

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.

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.

Class com.amazonaws.services.rds.model.DescribeDBEngineVersionsResult

class DescribeDBEngineVersionsResult extends Object implements Serializable

Serialized Fields

dBEngineVersions

com.amazonaws.internal.SdkInternalList<DBEngineVersion> dBEngineVersions

A list of DBEngineVersion elements.

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

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeDBInstancesResult extends Object implements Serializable

Serialized Fields

dBInstances

com.amazonaws.internal.SdkInternalList<DBInstance> dBInstances

A list of DBInstance instances.

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

class DescribeDBLogFilesDetails extends Object implements Serializable

Serialized Fields

lastWritten

Long lastWritten

A POSIX timestamp when the last log entry was written.

logFileName

String logFileName

The name of the log file for the specified DB instance.

size

Long size

The size, in bytes, of the log file for the specified DB instance.

Class com.amazonaws.services.rds.model.DescribeDBLogFilesRequest

class 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

fileLastWritten

Long fileLastWritten

Filters the available log files for files written since the specified date, in POSIX timestamp format with milliseconds.

filenameContains

String filenameContains

Filters the available log files for log file names that contain the specified string.

fileSize

Long fileSize

Filters the available log files for files larger than the specified size.

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

Class com.amazonaws.services.rds.model.DescribeDBLogFilesResult

class DescribeDBLogFilesResult extends Object implements Serializable

Serialized Fields

describeDBLogFiles

com.amazonaws.internal.SdkInternalList<DescribeDBLogFilesDetails> 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

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeDBParameterGroupsResult extends Object implements Serializable

Serialized Fields

dBParameterGroups

com.amazonaws.internal.SdkInternalList<DBParameterGroup> dBParameterGroups

A list of DBParameterGroup instances.

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

class 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

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

source

String source

The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

Class com.amazonaws.services.rds.model.DescribeDBParametersResult

class DescribeDBParametersResult 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.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of Parameter values.

Class com.amazonaws.services.rds.model.DescribeDBSecurityGroupsRequest

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeDBSecurityGroupsResult extends Object implements Serializable

Serialized Fields

dBSecurityGroups

com.amazonaws.internal.SdkInternalList<DBSecurityGroup> dBSecurityGroups

A list of DBSecurityGroup instances.

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

class 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

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

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

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.

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.

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.

Class com.amazonaws.services.rds.model.DescribeDBSnapshotsResult

class DescribeDBSnapshotsResult extends Object implements Serializable

Serialized Fields

dBSnapshots

com.amazonaws.internal.SdkInternalList<DBSnapshot> dBSnapshots

A list of DBSnapshot instances.

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

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeDBSubnetGroupsResult extends Object implements Serializable

Serialized Fields

dBSubnetGroups

com.amazonaws.internal.SdkInternalList<DBSubnetGroup> dBSubnetGroups

A list of DBSubnetGroup instances.

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

class 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.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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

class DescribeEngineDefaultParametersRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBParameterGroupFamily

String dBParameterGroupFamily

The name of the DB parameter group family.

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

Not currently supported.

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.

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

class DescribeEventCategoriesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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

Class com.amazonaws.services.rds.model.DescribeEventCategoriesResult

class DescribeEventCategoriesResult extends Object implements Serializable

Serialized Fields

eventCategoriesMapList

com.amazonaws.internal.SdkInternalList<EventCategoriesMap> eventCategoriesMapList

A list of EventCategoriesMap data types.

Class com.amazonaws.services.rds.model.DescribeEventsRequest

class DescribeEventsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

duration

Integer duration

The number of minutes to retrieve events for.

Default: 60

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

eventCategories

com.amazonaws.internal.SdkInternalList<String> eventCategories

A list of event categories that trigger notifications for a event notification subscription.

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

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.

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

Class com.amazonaws.services.rds.model.DescribeEventsResult

class DescribeEventsResult extends Object implements Serializable

Serialized Fields

events

com.amazonaws.internal.SdkInternalList<Event> events

A list of Event instances.

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 .

Class com.amazonaws.services.rds.model.DescribeEventSubscriptionsRequest

class DescribeEventSubscriptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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 .

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.

subscriptionName

String subscriptionName

The name of the RDS event notification subscription you want to describe.

Class com.amazonaws.services.rds.model.DescribeEventSubscriptionsResult

class DescribeEventSubscriptionsResult extends Object implements Serializable

Serialized Fields

eventSubscriptionsList

com.amazonaws.internal.SdkInternalList<EventSubscription> eventSubscriptionsList

A list of EventSubscriptions data types.

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

class DescribeOptionGroupOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engineName

String engineName

A required parameter. Options available for the given engine name will be described.

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

majorEngineVersion

String majorEngineVersion

If specified, filters the results to include only options for the specified major engine version.

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.

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

class DescribeOptionGroupOptionsResult 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.

optionGroupOptions

com.amazonaws.internal.SdkInternalList<OptionGroupOption> optionGroupOptions

Class com.amazonaws.services.rds.model.DescribeOptionGroupsRequest

class DescribeOptionGroupsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

engineName

String engineName

Filters the list of option groups to only include groups associated with a specific database engine.

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

optionGroupName

String optionGroupName

The name of the option group to describe. Cannot be supplied together with EngineName or MajorEngineVersion.

Class com.amazonaws.services.rds.model.DescribeOptionGroupsResult

class DescribeOptionGroupsResult 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.

optionGroupsList

com.amazonaws.internal.SdkInternalList<OptionGroup> optionGroupsList

List of option groups.

Class com.amazonaws.services.rds.model.DescribeOrderableDBInstanceOptionsRequest

class DescribeOrderableDBInstanceOptionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceClass

String dBInstanceClass

The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.

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.

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

licenseModel

String licenseModel

The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

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 .

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.

vpc

Boolean vpc

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

Class com.amazonaws.services.rds.model.DescribeOrderableDBInstanceOptionsResult

class DescribeOrderableDBInstanceOptionsResult extends Object implements Serializable

Serialized Fields

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 .

orderableDBInstanceOptions

com.amazonaws.internal.SdkInternalList<OrderableDBInstanceOption> orderableDBInstanceOptions

An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.

Class com.amazonaws.services.rds.model.DescribePendingMaintenanceActionsRequest

class DescribePendingMaintenanceActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> 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.

resourceIdentifier

String resourceIdentifier

The ARN of a resource to return pending maintenance actions for.

Class com.amazonaws.services.rds.model.DescribePendingMaintenanceActionsResult

class DescribePendingMaintenanceActionsResult extends Object implements Serializable

Serialized Fields

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.

pendingMaintenanceActions

com.amazonaws.internal.SdkInternalList<ResourcePendingMaintenanceActions> pendingMaintenanceActions

A list of the pending maintenance actions for the resource.

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesOfferingsRequest

class DescribeReservedDBInstancesOfferingsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

multiAZ

Boolean multiAZ

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

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"

productDescription

String productDescription

Product description filter value. Specify this parameter to show only the available offerings matching the specified product description.

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

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesOfferingsResult

class 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.SdkInternalList<ReservedDBInstancesOffering> reservedDBInstancesOfferings

A list of reserved DB instance offerings.

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesRequest

class DescribeReservedDBInstancesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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.

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.

multiAZ

Boolean multiAZ

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

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"

productDescription

String productDescription

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

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.

Class com.amazonaws.services.rds.model.DescribeReservedDBInstancesResult

class 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.SdkInternalList<ReservedDBInstance> reservedDBInstances

A list of reserved DB instances.

Class com.amazonaws.services.rds.model.DomainMembership

class DomainMembership extends Object implements Serializable

Serialized Fields

domain

String domain

The identifier of the Active Directory Domain.

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.

status

String status

The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc).

Exception Class com.amazonaws.services.rds.model.DomainNotFoundException

class DomainNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.DownloadDBLogFilePortionRequest

class 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

class DownloadDBLogFilePortionResult extends Object implements Serializable

Serialized Fields

additionalDataPending

Boolean additionalDataPending

Boolean value that if true, indicates there is more data to be downloaded.

logFileData

String logFileData

Entries from the specified log file.

marker

String marker

A pagination token that can be used in a subsequent DownloadDBLogFilePortion request.

Class com.amazonaws.services.rds.model.EC2SecurityGroup

class EC2SecurityGroup extends Object implements Serializable

Serialized Fields

eC2SecurityGroupId

String eC2SecurityGroupId

Specifies the id of the EC2 security group.

eC2SecurityGroupName

String eC2SecurityGroupName

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

status

String status

Provides the status of the EC2 security group. Status can be "authorizing", "authorized", "revoking", and "revoked".

Class com.amazonaws.services.rds.model.Endpoint

class Endpoint extends Object implements Serializable

Serialized Fields

address

String address

Specifies the DNS address of the DB instance.

hostedZoneId

String hostedZoneId

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

port

Integer port

Specifies the port that the database engine is listening on.

Class com.amazonaws.services.rds.model.EngineDefaults

class 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.SdkInternalList<Parameter> parameters

Contains a list of engine default parameters.

Class com.amazonaws.services.rds.model.Event

class Event extends Object implements Serializable

Serialized Fields

dateValue

Date dateValue

Specifies the date and time of the event.

eventCategories

com.amazonaws.internal.SdkInternalList<String> eventCategories

Specifies the category for the event.

message

String message

Provides the text of this event.

sourceIdentifier

String sourceIdentifier

Provides the identifier for the source of the event.

sourceType

String sourceType

Specifies the source type for this event.

Class com.amazonaws.services.rds.model.EventCategoriesMap

class EventCategoriesMap extends Object implements Serializable

Serialized Fields

eventCategories

com.amazonaws.internal.SdkInternalList<String> eventCategories

The event categories for the specified source type

sourceType

String sourceType

The source type that the returned categories belong to

Class com.amazonaws.services.rds.model.EventSubscription

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

enabled

Boolean enabled

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

eventCategoriesList

com.amazonaws.internal.SdkInternalList<String> eventCategoriesList

A list of event categories for the RDS event notification subscription.

snsTopicArn

String snsTopicArn

The topic ARN of the RDS event notification subscription.

sourceIdsList

com.amazonaws.internal.SdkInternalList<String> sourceIdsList

A list of source IDs for the RDS event notification subscription.

sourceType

String sourceType

The source type for 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.

Exception Class com.amazonaws.services.rds.model.EventSubscriptionQuotaExceededException

class EventSubscriptionQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.FailoverDBClusterRequest

class 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

class Filter extends Object implements Serializable

Serialized Fields

name

String name

This parameter is not currently supported.

values

com.amazonaws.internal.SdkInternalList<String> values

This parameter is not currently supported.

Exception Class com.amazonaws.services.rds.model.InstanceQuotaExceededException

class InstanceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InsufficientDBClusterCapacityException

class InsufficientDBClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InsufficientDBInstanceCapacityException

class InsufficientDBInstanceCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InsufficientStorageClusterCapacityException

class InsufficientStorageClusterCapacityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBClusterSnapshotStateException

class InvalidDBClusterSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBClusterStateException

class InvalidDBClusterStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBInstanceStateException

class InvalidDBInstanceStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBParameterGroupStateException

class InvalidDBParameterGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBSecurityGroupStateException

class InvalidDBSecurityGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBSnapshotStateException

class InvalidDBSnapshotStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBSubnetGroupException

class InvalidDBSubnetGroupException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBSubnetGroupStateException

class InvalidDBSubnetGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidDBSubnetStateException

class InvalidDBSubnetStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidEventSubscriptionStateException

class InvalidEventSubscriptionStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidOptionGroupStateException

class InvalidOptionGroupStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidRestoreException

class InvalidRestoreException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidSubnetException

class InvalidSubnetException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.InvalidVPCNetworkStateException

class InvalidVPCNetworkStateException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.IPRange

class IPRange extends Object implements Serializable

Serialized Fields

cIDRIP

String cIDRIP

Specifies the IP range.

status

String status

Specifies the status of the IP range. Status can be "authorizing", "authorized", "revoking", and "revoked".

Exception Class com.amazonaws.services.rds.model.KMSKeyNotAccessibleException

class KMSKeyNotAccessibleException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.ListTagsForResourceRequest

class ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

filters

com.amazonaws.internal.SdkInternalList<Filter> filters

This parameter is not currently supported.

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

Class com.amazonaws.services.rds.model.ListTagsForResourceResult

class ListTagsForResourceResult extends Object implements Serializable

Serialized Fields

tagList

com.amazonaws.internal.SdkInternalList<Tag> tagList

List of tags returned by the ListTagsForResource operation.

Class com.amazonaws.services.rds.model.ModifyDBClusterParameterGroupRequest

class ModifyDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBClusterParameterGroupName

String dBClusterParameterGroupName

The name of the DB cluster parameter group to modify.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> parameters

A list of parameters in the DB cluster parameter group to modify.

Class com.amazonaws.services.rds.model.ModifyDBClusterParameterGroupResult

class 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

class ModifyDBClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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.

dBClusterParameterGroupName

String dBClusterParameterGroupName

The name of the DB cluster parameter group to use for the 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.

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

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.

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.

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.

vpcSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupIds

A lst of VPC security groups that the DB cluster will belong to.

Class com.amazonaws.services.rds.model.ModifyDBInstanceRequest

class ModifyDBInstanceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.

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

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.

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

cACertificateIdentifier

String cACertificateIdentifier

Indicates the certificate that needs to be associated with the instance.

copyTagsToSnapshot

Boolean copyTagsToSnapshot

True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false.

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

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

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.

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

dBSecurityGroups

com.amazonaws.internal.SdkInternalList<String> 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

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.

domainIAMRoleName

String domainIAMRoleName

Specify the name of the IAM role to be used when making API calls to the Directory Service.

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.

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.

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.

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.

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.

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

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

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

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

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

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.

vpcSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> 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

Class com.amazonaws.services.rds.model.ModifyDBParameterGroupRequest

class 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.SdkInternalList<Parameter> 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

class 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

class ModifyDBSnapshotAttributeRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

dBSnapshotIdentifier

String dBSnapshotIdentifier

The identifier for the DB snapshot to modify the attributes for.

valuesToAdd

com.amazonaws.internal.SdkInternalList<String> 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.SdkInternalList<String> 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

class ModifyDBSubnetGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBSubnetGroupDescription

String dBSubnetGroupDescription

The description for the DB subnet group.

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

subnetIds

com.amazonaws.internal.SdkInternalList<String> subnetIds

The EC2 subnet IDs for the DB subnet group.

Class com.amazonaws.services.rds.model.ModifyEventSubscriptionRequest

class ModifyEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

enabled

Boolean enabled

A Boolean value; set to true to activate the subscription.

eventCategories

com.amazonaws.internal.SdkInternalList<String> 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.

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

subscriptionName

String subscriptionName

The name of the RDS event notification subscription.

Class com.amazonaws.services.rds.model.ModifyOptionGroupRequest

class ModifyOptionGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

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.SdkInternalList<OptionConfiguration> 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.SdkInternalList<String> optionsToRemove

Options in this list are removed from the option group.

Class com.amazonaws.services.rds.model.Option

class Option extends Object implements Serializable

Serialized Fields

dBSecurityGroupMemberships

com.amazonaws.internal.SdkInternalList<DBSecurityGroupMembership> dBSecurityGroupMemberships

If the option requires access to a port, then this DB security group allows access to the port.

optionDescription

String optionDescription

The description of the option.

optionName

String optionName

The name of the option.

optionSettings

com.amazonaws.internal.SdkInternalList<OptionSetting> optionSettings

The option settings for this option.

permanent

Boolean permanent

Indicate if this option is permanent.

persistent

Boolean persistent

Indicate if this option is persistent.

port

Integer port

If required, the port configured for this option to use.

vpcSecurityGroupMemberships

com.amazonaws.internal.SdkInternalList<VpcSecurityGroupMembership> 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

class OptionConfiguration extends Object implements Serializable

Serialized Fields

dBSecurityGroupMemberships

com.amazonaws.internal.SdkInternalList<String> dBSecurityGroupMemberships

A list of DBSecurityGroupMemebrship name strings used for this option.

optionName

String optionName

The configuration of options to include in a group.

optionSettings

com.amazonaws.internal.SdkInternalList<OptionSetting> optionSettings

The option settings to include in an option group.

port

Integer port

The optional port for the option.

vpcSecurityGroupMemberships

com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupMemberships

A list of VpcSecurityGroupMemebrship name strings used for this option.

Class com.amazonaws.services.rds.model.OptionGroup

class OptionGroup extends Object implements Serializable

Serialized Fields

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.

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.

optionGroupDescription

String optionGroupDescription

Provides a description of the option group.

optionGroupName

String optionGroupName

Specifies the name of the option group.

options

com.amazonaws.internal.SdkInternalList<Option> options

Indicates what options are available in the option group.

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.

Exception Class com.amazonaws.services.rds.model.OptionGroupAlreadyExistsException

class OptionGroupAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.OptionGroupMembership

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

Exception Class com.amazonaws.services.rds.model.OptionGroupNotFoundException

class OptionGroupNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.OptionGroupOption

class OptionGroupOption extends Object implements Serializable

Serialized Fields

defaultPort

Integer defaultPort

If the option requires a port, specifies the default port for 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.

name

String name

The name of the option.

optionGroupOptionSettings

com.amazonaws.internal.SdkInternalList<OptionGroupOptionSetting> optionGroupOptionSettings

Specifies the option settings that are available (and the default value) for each option in an option group.

optionsDependedOn

com.amazonaws.internal.SdkInternalList<String> optionsDependedOn

List of all options that are prerequisites for 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.

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.

portRequired

Boolean portRequired

Specifies whether the option requires a port.

Class com.amazonaws.services.rds.model.OptionGroupOptionSetting

class OptionGroupOptionSetting extends Object implements Serializable

Serialized Fields

allowedValues

String allowedValues

Indicates the acceptable values for the option group option.

applyType

String applyType

The DB engine specific parameter type for the option group option.

defaultValue

String defaultValue

The default value 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.

settingDescription

String settingDescription

The description of the option group option.

settingName

String settingName

The name of the option group option.

Exception Class com.amazonaws.services.rds.model.OptionGroupQuotaExceededException

class OptionGroupQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.OptionSetting

class OptionSetting extends Object implements Serializable

Serialized Fields

allowedValues

String allowedValues

The allowed values of the option setting.

applyType

String applyType

The DB engine specific parameter type.

dataType

String dataType

The data type of the option setting.

defaultValue

String defaultValue

The default value of the option setting.

description

String description

The description of the option setting.

isCollection

Boolean isCollection

Indicates if the option setting is part of a collection.

isModifiable

Boolean isModifiable

A Boolean value that, when true, indicates the option setting can be modified from the default.

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.

Class com.amazonaws.services.rds.model.OrderableDBInstanceOption

class OrderableDBInstanceOption extends Object implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<AvailabilityZone> availabilityZones

A list of Availability Zones for the orderable DB instance.

dBInstanceClass

String dBInstanceClass

The DB instance class for the orderable DB instance.

engine

String engine

The engine type of the orderable DB instance.

engineVersion

String engineVersion

The engine version of the orderable DB instance.

licenseModel

String licenseModel

The license model 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.

storageType

String storageType

Indicates the storage type for this orderable DB instance.

supportsEnhancedMonitoring

Boolean supportsEnhancedMonitoring

Indicates whether the DB instance supports enhanced monitoring at intervals from 1 to 60 seconds.

supportsIops

Boolean supportsIops

Indicates whether this orderable DB instance supports provisioned IOPS.

supportsStorageEncryption

Boolean supportsStorageEncryption

Indicates whether this orderable DB instance supports encrypted storage.

vpc

Boolean vpc

Indicates whether this is a VPC orderable DB instance.

Class com.amazonaws.services.rds.model.Parameter

class Parameter extends Object implements Serializable

Serialized Fields

allowedValues

String allowedValues

Specifies the valid range of values for the parameter.

applyMethod

String applyMethod

Indicates when to apply parameter updates.

applyType

String applyType

Specifies the engine specific parameters type.

dataType

String dataType

Specifies the valid data type for the parameter.

description

String description

Provides a description of 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.

parameterName

String parameterName

Specifies the name of the parameter.

parameterValue

String parameterValue

Specifies the value of the parameter.

source

String source

Indicates the source of the parameter value.

Class com.amazonaws.services.rds.model.PendingMaintenanceAction

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

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.

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.

Class com.amazonaws.services.rds.model.PendingModifiedValues

class PendingModifiedValues extends Object implements Serializable

Serialized Fields

allocatedStorage

Integer allocatedStorage

Contains the new AllocatedStorage size for the DB instance that will be applied or is in progress.

backupRetentionPeriod

Integer backupRetentionPeriod

Specifies the pending number of days for which automated backups are retained.

cACertificateIdentifier

String cACertificateIdentifier

Specifies the identifier of the CA certificate for the DB instance.

dBInstanceClass

String dBInstanceClass

Contains the new DBInstanceClass for the DB instance that will be applied or is in progress.

dBInstanceIdentifier

String dBInstanceIdentifier

Contains the new DBInstanceIdentifier for the DB instance that will be applied or is in progress.

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.

masterUserPassword

String masterUserPassword

Contains the pending or in-progress change of the master credentials for the DB instance.

multiAZ

Boolean multiAZ

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

port

Integer port

Specifies the pending port for the DB instance.

storageType

String storageType

Specifies the storage type to be associated with the DB instance.

Exception Class com.amazonaws.services.rds.model.PointInTimeRestoreNotEnabledException

class PointInTimeRestoreNotEnabledException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.PromoteReadReplicaRequest

class PromoteReadReplicaRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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

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

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.

Exception Class com.amazonaws.services.rds.model.ProvisionedIopsNotAvailableInAZException

class ProvisionedIopsNotAvailableInAZException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.PurchaseReservedDBInstancesOfferingRequest

class PurchaseReservedDBInstancesOfferingRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBInstanceCount

Integer dBInstanceCount

The number of instances to reserve.

Default: 1

reservedDBInstanceId

String reservedDBInstanceId

Customer-specified identifier to track this reservation.

Example: myreservationID

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

Class com.amazonaws.services.rds.model.RebootDBInstanceRequest

class 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

class 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

class RemoveSourceIdentifierFromSubscriptionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

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.

subscriptionName

String subscriptionName

The name of the RDS event notification subscription you want to remove a source identifier from.

Class com.amazonaws.services.rds.model.RemoveTagsFromResourceRequest

class 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.SdkInternalList<String> tagKeys

The tag key (name) of the tag to be removed.

Class com.amazonaws.services.rds.model.RemoveTagsFromResourceResult

class RemoveTagsFromResourceResult extends Object implements Serializable

Class com.amazonaws.services.rds.model.ReservedDBInstance

class ReservedDBInstance extends Object implements Serializable

Serialized Fields

currencyCode

String currencyCode

The currency code for the reserved DB instance.

dBInstanceClass

String dBInstanceClass

The DB instance class for the reserved DB instance.

dBInstanceCount

Integer dBInstanceCount

The number of reserved DB instances.

duration

Integer duration

The duration of the reservation in seconds.

fixedPrice

Double fixedPrice

The fixed price charged for this reserved DB instance.

multiAZ

Boolean multiAZ

Indicates if the reservation applies to Multi-AZ deployments.

offeringType

String offeringType

The offering type of this reserved DB instance.

productDescription

String productDescription

The description of the reserved DB instance.

recurringCharges

com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

The recurring price charged to run this reserved DB instance.

reservedDBInstanceId

String reservedDBInstanceId

The unique identifier for the reservation.

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The offering identifier.

startTime

Date startTime

The time the reservation started.

state

String state

The state of the reserved DB instance.

usagePrice

Double usagePrice

The hourly price charged for this reserved DB instance.

Exception Class com.amazonaws.services.rds.model.ReservedDBInstanceAlreadyExistsException

class ReservedDBInstanceAlreadyExistsException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.ReservedDBInstanceNotFoundException

class ReservedDBInstanceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Exception Class com.amazonaws.services.rds.model.ReservedDBInstanceQuotaExceededException

class ReservedDBInstanceQuotaExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.ReservedDBInstancesOffering

class ReservedDBInstancesOffering extends Object implements Serializable

Serialized Fields

currencyCode

String currencyCode

The currency code for the reserved DB instance offering.

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.

multiAZ

Boolean multiAZ

Indicates if the offering applies to Multi-AZ deployments.

offeringType

String offeringType

The offering type.

productDescription

String productDescription

The database engine used by the offering.

recurringCharges

com.amazonaws.internal.SdkInternalList<RecurringCharge> recurringCharges

The recurring price charged to run this reserved DB instance.

reservedDBInstancesOfferingId

String reservedDBInstancesOfferingId

The offering identifier.

usagePrice

Double usagePrice

The hourly price charged for this offering.

Exception Class com.amazonaws.services.rds.model.ReservedDBInstancesOfferingNotFoundException

class ReservedDBInstancesOfferingNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.ResetDBClusterParameterGroupRequest

class ResetDBClusterParameterGroupRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

dBClusterParameterGroupName

String dBClusterParameterGroupName

The name of the DB cluster parameter group to reset.

parameters

com.amazonaws.internal.SdkInternalList<Parameter> 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.

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.

Class com.amazonaws.services.rds.model.ResetDBClusterParameterGroupResult

class 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

class 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

parameters

com.amazonaws.internal.SdkInternalList<Parameter> 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

resetAllParameters

Boolean resetAllParameters

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

Class com.amazonaws.services.rds.model.ResetDBParameterGroupResult

class ResetDBParameterGroupResult extends Object implements Serializable

Serialized Fields

dBParameterGroupName

String dBParameterGroupName

Provides the name of the DB parameter group.

Exception Class com.amazonaws.services.rds.model.ResourceNotFoundException

class ResourceNotFoundException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.rds.model.ResourcePendingMaintenanceActions

class ResourcePendingMaintenanceActions extends Object implements Serializable

Serialized Fields

pendingMaintenanceActionDetails

com.amazonaws.internal.SdkInternalList<PendingMaintenanceAction> pendingMaintenanceActionDetails

A list that provides details about the pending maintenance actions for the resource.

resourceIdentifier

String resourceIdentifier

The ARN of the resource that has pending maintenance actions.

Class com.amazonaws.services.rds.model.RestoreDBClusterFromSnapshotRequest

class RestoreDBClusterFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

availabilityZones

com.amazonaws.internal.SdkInternalList<String> availabilityZones

Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.

databaseName

String databaseName

The database name for the restored DB cluster.

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

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

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.

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.

optionGroupName

String optionGroupName

The name of the option group to use for the restored 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.

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

tags

com.amazonaws.internal.SdkInternalList<Tag> tags

The tags to be assigned to the restored DB cluster.

vpcSecurityGroupIds

com.amazonaws.internal.SdkInternalList<String> vpcSecurityGroupIds

A list of VPC security groups that the new DB cluster will belong to.

Class com.amazonaws.services.rds.model.RestoreDBClusterToPointInTimeRequest

class 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

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

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.